# Destinations

> Create, list, retrieve, update, and delete destinations in the Ours Privacy REST API, discover supported destination types, and configure destination-specific settings through the shared settings object.

Source: https://docs.oursprivacy.com/docs/platform-api/destinations

Use this page to create, list, retrieve, update, and delete destinations in your account.

## Where this fits in the dispatch flow

Destinations are the last stop:

Event dispatch flow: [Source](https://docs.oursprivacy.com/docs/platform-api/sources) → [Allowed Events](https://docs.oursprivacy.com/docs/platform-api/allowed-events) → [Data Governance](https://docs.oursprivacy.com/docs/platform-api/data-governance) → [Mappings](https://docs.oursprivacy.com/docs/platform-api/mappings) → **Destination (this page)**

Configuration changes at any stage take effect once you publish a [new version](https://docs.oursprivacy.com/docs/platform-api/versions).

A destination only receives an event if (1) an [allowed event](https://docs.oursprivacy.com/docs/platform-api/allowed-events) lists it on `destinationIds`, (2) no [data-governance](https://docs.oursprivacy.com/docs/platform-api/data-governance) category stops dispatch, and (3) a [mapping](https://docs.oursprivacy.com/docs/platform-api/mappings) on this destination matches. Configuring a destination here without setting up the upstream stages will leave it idle.

Every destination's per-type configuration lives under the polymorphic `settings` object on both reads and writes.

## Discover destination types

Before you create a destination, use the destination-type discovery endpoints to see which `type` values are available and which `settings` keys each one accepts.

They describe every destination type the platform offers, so you can populate a destination picker in your UI or generate infrastructure-as-code against the destinations API.

`POST /destinations` creates event-dispatch destinations. Warehouse, cloud-storage, and audience destinations are set up in the dashboard and appear on read responses here. Audience destinations receive audience membership on a daily schedule and are targeted from an [audience](https://docs.oursprivacy.com/docs/audiences/audience-destinations).

Settings entries with `type: Alert` are informational messages displayed in the UI. Do not include their `key` in `POST` or `PATCH` `settings`.

## Configuring a destination

`POST` and `PATCH` accept the configuration under `settings.<key>`:

```bash
curl -X POST "$BASE/rest/v1/destinations" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My Klaviyo",
    "type": "Klaviyo",
    "settings": { "projectAPIKey": "pk_live_..." }
  }'
```

`GET` returns the same shape. Populated configuration is always under `settings`:

```jsonc
{
  "id": "885d88b9-...",
  "name": "My Klaviyo",
  "type": "Klaviyo",
  "status": "Disabled",
  "settings": { "projectAPIKey": "******" },
}
```

New destinations start `Disabled` and send nothing until you set `"status": "Enabled"`, either in the `POST` body or with a later `PATCH` once the destination is ready.

Destination updates follow the standard API `PATCH` behavior documented in the [API Overview](https://docs.oursprivacy.com/docs/platform-api). The destination-specific rule is that per-type configuration keys always live under `settings`.

`POST` and `PATCH` both return the full destination entity, in the same shape as `GET /rest/v1/destinations/{id}`.

## GET /rest/v1/destinations

List all destinations. Requires API-key scope or current OAuth user permission: destination:list

Request URL: `GET https://app.oursprivacy.com/rest/v1/destinations`

Authentication: apiKey or oauth2.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `limit` | query | integer \| null | No | Maximum number of destinations to return. Defaults to 25; values below 1 are clamped to 1 and values above 200 are clamped to 200. |
| `cursor` | query | string | No | Opaque pagination cursor from pagination.nextCursor in the previous response. Do not decode or modify it. Malformed cursors return 400 Bad Request. Opaque pagination cursor from pagination.nextCursor in the previous response. Do not decode or modify it. Malformed cursors return 400 Bad Request. |
| `status` | query | string | No | Filter destinations by status. One of: `"Disabled"`, `"Enabled"`. |
| `type` | query | string | No | Filter destinations by destination type. One of: `"AWSEventBridge"`, `"AWSKinesis"`, `"AWSLambda"`, `"AWSS3"`, `"AWSSNS"`, `"ActiveCampaignApi"`, `"AdRollCAPI"`, `"Admitad"`, `"AdobeAnalytics"`, `"Affiliatly"`, `"AmazonDSP"`, `"Amplitude"`, `"AppLovin"`, `"ArtsAI"`, `"Attentive"`, `"Audiohook"`, `"AzureBlob"`, `"BasisPostback"`, `"BeeswaxPostback"`, `"BingAds"`, `"BingAdsWeb"`, `"BingRest"`, `"Braze"`, `"BrazeAudience"`, `"ConvertABTestingEvent"`, `"Customerio"`, `"DatabricksWarehouse"`, `"DomoWarehouse"`, `"Everflow"`, `"Facebook"`, `"FacebookAudience"`, `"FloodlightSGTM"`, `"FullContact"`, `"Fullstory"`, `"G4Analytics"`, `"GA4MeasurementProtocol"`, `"GA4ServerProxy"`, `"Google"`, `"GoogleAds360"`, `"GoogleAdsServerContainer"`, `"GoogleAudience"`, `"GoogleBigQuery"`, `"GoogleBigQueryWarehouse"`, `"GoogleDataManagerEventIngest"`, `"GooglePubSub"`, `"GoogleStorage"`, `"GravityCAPI"`, `"GrowthChannel"`, `"HTTPCustomRequest"`, `"HTTPDestination"`, `"Hubspot"`, `"IHeartMediaMagellan"`, `"Impact"`, `"Iterable"`, `"Katalys"`, `"Klaviyo"`, `"LeadSquared"`, `"LinkedInAdsCAPI"`, `"LiveIntent"`, `"LiveRampWarehouse"`, `"MNTN"`, `"MNTNAudience"`, `"Mailchimp"`, `"MailchimpAudience"`, `"MicrosoftCAPI"`, `"Mixpanel"`, `"NextdoorAds"`, `"OpenAIAds"`, `"OursSyntheticData"`, `"Outbrain"`, `"Partnerize"`, `"Pinterest"`, `"Plausible"`, `"Podscribe"`, `"PostHog"`, `"QuantcastCAPI"`, `"QuoraAds"`, `"Reddit"`, `"RedditCapiV3"`, `"Rokt"`, `"RokuCAPI"`, `"SnapchatAdsCapi"`, `"Spotify"`, `"StackAdaptAPI"`, `"Taboola"`, `"Tatari"`, `"TatariCAPI"`, `"TheTradeDesk"`, `"TikTok"`, `"Trybe"`, `"UniversalAds"`, `"VWO"`, `"Viant"`, `"ViantCAPI"`, `"Vibe"`, `"VibeAudience"`, `"Woopra"`, `"XAds"`, `"XAdsV2"`, `"YelpCAPI"`, `"Zendesk"`, `"ZohoCRM"`, `"ZoomInfo"`. |

### Responses

- `200`: List of destinations
- `400`: Bad Request
- `401`: Unauthorized — missing, invalid, or expired API key or OAuth access token
- `403`: Forbidden — credential does not have the required current Ours permission
- `404`: Not Found
- `500`: Internal Server Error

#### `200` response body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `entities` | object[] | Yes |  |
| `entities[].id` | string | Yes |  |
| `entities[].name` | string \| null | No |  |
| `entities[].type` | string | Yes | Destination type. Read responses may include warehouse, cloud-storage, and audience-sync types that are not creatable through POST /rest/v1/destinations. One of: `"AWSEventBridge"`, `"AWSKinesis"`, `"AWSLambda"`, `"AWSS3"`, `"AWSSNS"`, `"ActiveCampaignApi"`, `"AdRollCAPI"`, `"Admitad"`, `"AdobeAnalytics"`, `"Affiliatly"`, `"AmazonDSP"`, `"Amplitude"`, `"AppLovin"`, `"ArtsAI"`, `"Attentive"`, `"Audiohook"`, `"AzureBlob"`, `"BasisPostback"`, `"BeeswaxPostback"`, `"BingAds"`, `"BingAdsWeb"`, `"BingRest"`, `"Braze"`, `"BrazeAudience"`, `"ConvertABTestingEvent"`, `"Customerio"`, `"DatabricksWarehouse"`, `"DomoWarehouse"`, `"Everflow"`, `"Facebook"`, `"FacebookAudience"`, `"FloodlightSGTM"`, `"FullContact"`, `"Fullstory"`, `"G4Analytics"`, `"GA4MeasurementProtocol"`, `"GA4ServerProxy"`, `"Google"`, `"GoogleAds360"`, `"GoogleAdsServerContainer"`, `"GoogleAudience"`, `"GoogleBigQuery"`, `"GoogleBigQueryWarehouse"`, `"GoogleDataManagerEventIngest"`, `"GooglePubSub"`, `"GoogleStorage"`, `"GravityCAPI"`, `"GrowthChannel"`, `"HTTPCustomRequest"`, `"HTTPDestination"`, `"Hubspot"`, `"IHeartMediaMagellan"`, `"Impact"`, `"Iterable"`, `"Katalys"`, `"Klaviyo"`, `"LeadSquared"`, `"LinkedInAdsCAPI"`, `"LiveIntent"`, `"LiveRampWarehouse"`, `"MNTN"`, `"MNTNAudience"`, `"Mailchimp"`, `"MailchimpAudience"`, `"MicrosoftCAPI"`, `"Mixpanel"`, `"NextdoorAds"`, `"OpenAIAds"`, `"OursSyntheticData"`, `"Outbrain"`, `"Partnerize"`, `"Pinterest"`, `"Plausible"`, `"Podscribe"`, `"PostHog"`, `"QuantcastCAPI"`, `"QuoraAds"`, `"Reddit"`, `"RedditCapiV3"`, `"Rokt"`, `"RokuCAPI"`, `"SnapchatAdsCapi"`, `"Spotify"`, `"StackAdaptAPI"`, `"Taboola"`, `"Tatari"`, `"TatariCAPI"`, `"TheTradeDesk"`, `"TikTok"`, `"Trybe"`, `"UniversalAds"`, `"VWO"`, `"Viant"`, `"ViantCAPI"`, `"Vibe"`, `"VibeAudience"`, `"Woopra"`, `"XAds"`, `"XAdsV2"`, `"YelpCAPI"`, `"Zendesk"`, `"ZohoCRM"`, `"ZoomInfo"`. |
| `entities[].status` | string | Yes | One of: `"Disabled"`, `"Enabled"`. |
| `entities[].createdAt` | string | Yes |  |
| `entities[].updatedAt` | string \| null | No |  |
| `entities[].settings` | object \| null | No |  |
| `entities[].limitedToSourceIds` | string[] \| null | No |  |
| `entities[].hashingSalt` | string \| null | No |  |
| `pagination` | object | Yes |  |
| `pagination.nextCursor` | string \| null | No |  |
| `pagination.hasMore` | boolean | Yes |  |

Full schema: [OpenAPI specification](https://docs.oursprivacy.com/openapi-platform.json).

## POST /rest/v1/destinations

Create a new destination. Requires API-key scope or current OAuth user permission: destination:create

Request URL: `POST https://app.oursprivacy.com/rest/v1/destinations`

Authentication: apiKey or oauth2.

### Request body (`application/json`, required)

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string \| null | No | Human-readable label shown in dashboards. Defaults to the type name when omitted. |
| `type` | string | Yes | Event-dispatch destination type to create. Discover valid types and their settings via GET /rest/v1/destinations/types. Warehouse, cloud-storage, and audience-sync destination types may appear on read responses but are not creatable through POST. Audience destinations receive audience membership from Audience Builder on a daily schedule and are configured in the dashboard. One of: `"Audiohook"`, `"BasisPostback"`, `"Outbrain"`, `"OursSyntheticData"`, `"FullContact"`, `"ZoomInfo"`, `"TheTradeDesk"`, `"Braze"`, `"LiveIntent"`, `"ConvertABTestingEvent"`, `"Customerio"`, `"BingAds"`, `"BingRest"`, `"BingAdsWeb"`, `"MicrosoftCAPI"`, `"HTTPDestination"`, `"Woopra"`, `"HTTPCustomRequest"`, `"Google"`, `"GoogleAdsServerContainer"`, `"G4Analytics"`, `"GA4ServerProxy"`, `"GA4MeasurementProtocol"`, `"GoogleAds360"`, `"Facebook"`, `"Mixpanel"`, `"Amplitude"`, `"TikTok"`, `"Reddit"`, `"RedditCapiV3"`, `"Podscribe"`, `"Pinterest"`, `"Mailchimp"`, `"AWSKinesis"`, `"AWSLambda"`, `"AWSSNS"`, `"GooglePubSub"`, `"LinkedInAdsCAPI"`, `"ActiveCampaignApi"`, `"StackAdaptAPI"`, `"Hubspot"`, `"Klaviyo"`, `"XAds"`, `"XAdsV2"`, `"QuoraAds"`, `"SnapchatAdsCapi"`, `"Partnerize"`, `"NextdoorAds"`, `"Tatari"`, `"TatariCAPI"`, `"Viant"`, `"ViantCAPI"`, `"Impact"`, `"Spotify"`, `"Taboola"`, `"AmazonDSP"`, `"AppLovin"`, `"IHeartMediaMagellan"`, `"Vibe"`, `"GoogleDataManagerEventIngest"`, `"Zendesk"`, `"Iterable"`, `"ArtsAI"`, `"QuantcastCAPI"`, `"FloodlightSGTM"`, `"VWO"`, `"Attentive"`, `"Admitad"`, `"Plausible"`, `"PostHog"`, `"RokuCAPI"`, `"Everflow"`, `"BeeswaxPostback"`, `"AdobeAnalytics"`, `"UniversalAds"`, `"OpenAIAds"`, `"YelpCAPI"`, `"AdRollCAPI"`, `"MNTN"`, `"ZohoCRM"`, `"Rokt"`, `"Fullstory"`, `"GravityCAPI"`, `"LeadSquared"`, `"Trybe"`, `"Affiliatly"`, `"Katalys"`, `"GrowthChannel"`. |
| `status` | string \| null | No | Initial status. Omit or send `null` for `Disabled`; send `Enabled` to create active. One of: `"Enabled"`, `"Disabled"`, `null`. |
| `limitedToSourceIds` | (string (uuid))[] \| null | No | Restrict dispatch to these source IDs. Omit on create or send `null` to accept every source. Unknown or other-account source IDs are dropped and duplicates are removed. An empty list, including one left after filtering, receives events from no source. |
| `settings` | object \| null | No | Per-type configuration keys and values. Call GET /rest/v1/destinations/types to discover valid keys. On PATCH, omitted keys are preserved and `null` clears a specific setting. |

### Responses

- `200`: Created destination
- `400`: Bad Request
- `401`: Unauthorized — missing, invalid, or expired API key or OAuth access token
- `403`: Forbidden — credential does not have the required current Ours permission
- `404`: Not Found
- `500`: Internal Server Error

#### `200` response body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes |  |
| `name` | string \| null | No |  |
| `type` | string | Yes | Destination type. Read responses may include warehouse, cloud-storage, and audience-sync types that are not creatable through POST /rest/v1/destinations. One of: `"AWSEventBridge"`, `"AWSKinesis"`, `"AWSLambda"`, `"AWSS3"`, `"AWSSNS"`, `"ActiveCampaignApi"`, `"AdRollCAPI"`, `"Admitad"`, `"AdobeAnalytics"`, `"Affiliatly"`, `"AmazonDSP"`, `"Amplitude"`, `"AppLovin"`, `"ArtsAI"`, `"Attentive"`, `"Audiohook"`, `"AzureBlob"`, `"BasisPostback"`, `"BeeswaxPostback"`, `"BingAds"`, `"BingAdsWeb"`, `"BingRest"`, `"Braze"`, `"BrazeAudience"`, `"ConvertABTestingEvent"`, `"Customerio"`, `"DatabricksWarehouse"`, `"DomoWarehouse"`, `"Everflow"`, `"Facebook"`, `"FacebookAudience"`, `"FloodlightSGTM"`, `"FullContact"`, `"Fullstory"`, `"G4Analytics"`, `"GA4MeasurementProtocol"`, `"GA4ServerProxy"`, `"Google"`, `"GoogleAds360"`, `"GoogleAdsServerContainer"`, `"GoogleAudience"`, `"GoogleBigQuery"`, `"GoogleBigQueryWarehouse"`, `"GoogleDataManagerEventIngest"`, `"GooglePubSub"`, `"GoogleStorage"`, `"GravityCAPI"`, `"GrowthChannel"`, `"HTTPCustomRequest"`, `"HTTPDestination"`, `"Hubspot"`, `"IHeartMediaMagellan"`, `"Impact"`, `"Iterable"`, `"Katalys"`, `"Klaviyo"`, `"LeadSquared"`, `"LinkedInAdsCAPI"`, `"LiveIntent"`, `"LiveRampWarehouse"`, `"MNTN"`, `"MNTNAudience"`, `"Mailchimp"`, `"MailchimpAudience"`, `"MicrosoftCAPI"`, `"Mixpanel"`, `"NextdoorAds"`, `"OpenAIAds"`, `"OursSyntheticData"`, `"Outbrain"`, `"Partnerize"`, `"Pinterest"`, `"Plausible"`, `"Podscribe"`, `"PostHog"`, `"QuantcastCAPI"`, `"QuoraAds"`, `"Reddit"`, `"RedditCapiV3"`, `"Rokt"`, `"RokuCAPI"`, `"SnapchatAdsCapi"`, `"Spotify"`, `"StackAdaptAPI"`, `"Taboola"`, `"Tatari"`, `"TatariCAPI"`, `"TheTradeDesk"`, `"TikTok"`, `"Trybe"`, `"UniversalAds"`, `"VWO"`, `"Viant"`, `"ViantCAPI"`, `"Vibe"`, `"VibeAudience"`, `"Woopra"`, `"XAds"`, `"XAdsV2"`, `"YelpCAPI"`, `"Zendesk"`, `"ZohoCRM"`, `"ZoomInfo"`. |
| `status` | string | Yes | One of: `"Disabled"`, `"Enabled"`. |
| `createdAt` | string | Yes |  |
| `updatedAt` | string \| null | No |  |
| `settings` | object \| null | No |  |
| `limitedToSourceIds` | string[] \| null | No |  |
| `hashingSalt` | string \| null | No |  |

Full schema: [OpenAPI specification](https://docs.oursprivacy.com/openapi-platform.json).

## GET /rest/v1/destinations/types

Lists every destination type the platform supports, with its human-readable label, capability flags (oauth, listsAccounts, supportsRenamedEvents), and the settings descriptor used to configure a destination of that type. Account-agnostic — the response is the same for every API key. Filter client-side to find a specific type (e.g. `Klaviyo`, `Facebook`). Requires API-key scope or current OAuth user permission: destination:list

Request URL: `GET https://app.oursprivacy.com/rest/v1/destinations/types`

Authentication: apiKey or oauth2.

### Responses

- `200`: Destination types with settings descriptors and capabilities
- `400`: Bad Request
- `401`: Unauthorized — missing, invalid, or expired API key or OAuth access token
- `403`: Forbidden — credential does not have the required current Ours permission
- `404`: Not Found
- `500`: Internal Server Error

#### `200` response body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `entities` | object[] | Yes |  |
| `entities[].id` | string | Yes | One of: `"Audiohook"`, `"BasisPostback"`, `"Outbrain"`, `"OursSyntheticData"`, `"FullContact"`, `"ZoomInfo"`, `"TheTradeDesk"`, `"Braze"`, `"LiveIntent"`, `"ConvertABTestingEvent"`, `"Customerio"`, `"BingAds"`, `"BingRest"`, `"BingAdsWeb"`, `"MicrosoftCAPI"`, `"HTTPDestination"`, `"Woopra"`, `"HTTPCustomRequest"`, `"Google"`, `"GoogleAdsServerContainer"`, `"G4Analytics"`, `"GA4ServerProxy"`, `"GA4MeasurementProtocol"`, `"GoogleAds360"`, `"Facebook"`, `"Mixpanel"`, `"Amplitude"`, `"TikTok"`, `"Reddit"`, `"RedditCapiV3"`, `"Podscribe"`, `"Pinterest"`, `"Mailchimp"`, `"AWSKinesis"`, `"AWSLambda"`, `"AWSSNS"`, `"GooglePubSub"`, `"LinkedInAdsCAPI"`, `"ActiveCampaignApi"`, `"StackAdaptAPI"`, `"Hubspot"`, `"Klaviyo"`, `"XAds"`, `"XAdsV2"`, `"QuoraAds"`, `"SnapchatAdsCapi"`, `"Partnerize"`, `"NextdoorAds"`, `"Tatari"`, `"TatariCAPI"`, `"Viant"`, `"ViantCAPI"`, `"Impact"`, `"Spotify"`, `"Taboola"`, `"AmazonDSP"`, `"AppLovin"`, `"IHeartMediaMagellan"`, `"Vibe"`, `"GoogleDataManagerEventIngest"`, `"Zendesk"`, `"Iterable"`, `"ArtsAI"`, `"QuantcastCAPI"`, `"FloodlightSGTM"`, `"VWO"`, `"Attentive"`, `"Admitad"`, `"Plausible"`, `"PostHog"`, `"RokuCAPI"`, `"Everflow"`, `"BeeswaxPostback"`, `"AdobeAnalytics"`, `"UniversalAds"`, `"OpenAIAds"`, `"YelpCAPI"`, `"AdRollCAPI"`, `"MNTN"`, `"ZohoCRM"`, `"Rokt"`, `"Fullstory"`, `"GravityCAPI"`, `"LeadSquared"`, `"Trybe"`, `"Affiliatly"`, `"Katalys"`, `"GrowthChannel"`. |
| `entities[].label` | string | Yes |  |
| `entities[].status` | string | Yes | One of: `"deprecated"`, `"ga"`. |
| `entities[].capabilities` | object | Yes |  |
| `entities[].capabilities.oauth` | boolean | Yes |  |
| `entities[].capabilities.listsAccounts` | boolean | Yes |  |
| `entities[].capabilities.supportsRenamedEvents` | boolean | Yes |  |
| `entities[].settings` | object[] | Yes |  |

Full schema: [OpenAPI specification](https://docs.oursprivacy.com/openapi-platform.json).

## GET /rest/v1/destinations/{id}/health

Snapshot of dispatch health for this destination over the trailing 24 hours: counts of succeeded, failed, and intentionally stopped/blocked dispatches, plus a derived `status`. Requires API-key scope or current OAuth user permission: destination:find

Request URL: `GET https://app.oursprivacy.com/rest/v1/destinations/{id}/health`

Authentication: apiKey or oauth2.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `id` | path | string | Yes |  |

### Responses

- `200`: Dispatch health snapshot for the destination
- `400`: Bad Request
- `401`: Unauthorized — missing, invalid, or expired API key or OAuth access token
- `403`: Forbidden — credential does not have the required current Ours permission
- `404`: Not Found
- `500`: Internal Server Error

#### `200` response body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `status` | string | Yes | HEALTHY (>=95% of decisive dispatches succeeded), DEGRADED (50-95%), UNHEALTHY (<50%), or NO_DATA (no succeeded/failed dispatches in the window). One of: `"DEGRADED"`, `"HEALTHY"`, `"NO_DATA"`, `"UNHEALTHY"`. |
| `windowStart` | string | Yes | Start of the snapshot window (ISO 8601). |
| `windowEnd` | string | Yes | End of the snapshot window (ISO 8601). |
| `totalDispatches` | number | Yes | All dispatch attempts in the window, including stopped/blocked ones. |
| `successCount` | number | Yes |  |
| `failureCount` | number | Yes |  |
| `stoppedCount` | number | Yes | Dispatches intentionally stopped before send (not a failure). |
| `globalStopCount` | number | Yes | Dispatches blocked by an account-wide dispatch rule (not a failure). |
| `successRate` | number \| null | No | successCount / (successCount + failureCount). Null when there were no succeeded/failed dispatches in the window. |
| `lastDispatchedAt` | string \| null | No | ISO 8601 timestamp of the most recent successful dispatch to this destination within the health window. Null when none succeeded in the window. |

Full schema: [OpenAPI specification](https://docs.oursprivacy.com/openapi-platform.json).

## GET /rest/v1/destinations/{id}

Find a single destination by ID. Requires API-key scope or current OAuth user permission: destination:find

Request URL: `GET https://app.oursprivacy.com/rest/v1/destinations/{id}`

Authentication: apiKey or oauth2.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `id` | path | string | Yes |  |

### Responses

- `200`: Destination details
- `400`: Bad Request
- `401`: Unauthorized — missing, invalid, or expired API key or OAuth access token
- `403`: Forbidden — credential does not have the required current Ours permission
- `404`: Not Found
- `500`: Internal Server Error

#### `200` response body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes |  |
| `name` | string \| null | No |  |
| `type` | string | Yes | Destination type. Read responses may include warehouse, cloud-storage, and audience-sync types that are not creatable through POST /rest/v1/destinations. One of: `"AWSEventBridge"`, `"AWSKinesis"`, `"AWSLambda"`, `"AWSS3"`, `"AWSSNS"`, `"ActiveCampaignApi"`, `"AdRollCAPI"`, `"Admitad"`, `"AdobeAnalytics"`, `"Affiliatly"`, `"AmazonDSP"`, `"Amplitude"`, `"AppLovin"`, `"ArtsAI"`, `"Attentive"`, `"Audiohook"`, `"AzureBlob"`, `"BasisPostback"`, `"BeeswaxPostback"`, `"BingAds"`, `"BingAdsWeb"`, `"BingRest"`, `"Braze"`, `"BrazeAudience"`, `"ConvertABTestingEvent"`, `"Customerio"`, `"DatabricksWarehouse"`, `"DomoWarehouse"`, `"Everflow"`, `"Facebook"`, `"FacebookAudience"`, `"FloodlightSGTM"`, `"FullContact"`, `"Fullstory"`, `"G4Analytics"`, `"GA4MeasurementProtocol"`, `"GA4ServerProxy"`, `"Google"`, `"GoogleAds360"`, `"GoogleAdsServerContainer"`, `"GoogleAudience"`, `"GoogleBigQuery"`, `"GoogleBigQueryWarehouse"`, `"GoogleDataManagerEventIngest"`, `"GooglePubSub"`, `"GoogleStorage"`, `"GravityCAPI"`, `"GrowthChannel"`, `"HTTPCustomRequest"`, `"HTTPDestination"`, `"Hubspot"`, `"IHeartMediaMagellan"`, `"Impact"`, `"Iterable"`, `"Katalys"`, `"Klaviyo"`, `"LeadSquared"`, `"LinkedInAdsCAPI"`, `"LiveIntent"`, `"LiveRampWarehouse"`, `"MNTN"`, `"MNTNAudience"`, `"Mailchimp"`, `"MailchimpAudience"`, `"MicrosoftCAPI"`, `"Mixpanel"`, `"NextdoorAds"`, `"OpenAIAds"`, `"OursSyntheticData"`, `"Outbrain"`, `"Partnerize"`, `"Pinterest"`, `"Plausible"`, `"Podscribe"`, `"PostHog"`, `"QuantcastCAPI"`, `"QuoraAds"`, `"Reddit"`, `"RedditCapiV3"`, `"Rokt"`, `"RokuCAPI"`, `"SnapchatAdsCapi"`, `"Spotify"`, `"StackAdaptAPI"`, `"Taboola"`, `"Tatari"`, `"TatariCAPI"`, `"TheTradeDesk"`, `"TikTok"`, `"Trybe"`, `"UniversalAds"`, `"VWO"`, `"Viant"`, `"ViantCAPI"`, `"Vibe"`, `"VibeAudience"`, `"Woopra"`, `"XAds"`, `"XAdsV2"`, `"YelpCAPI"`, `"Zendesk"`, `"ZohoCRM"`, `"ZoomInfo"`. |
| `status` | string | Yes | One of: `"Disabled"`, `"Enabled"`. |
| `createdAt` | string | Yes |  |
| `updatedAt` | string \| null | No |  |
| `settings` | object \| null | No |  |
| `limitedToSourceIds` | string[] \| null | No |  |
| `hashingSalt` | string \| null | No |  |

Full schema: [OpenAPI specification](https://docs.oursprivacy.com/openapi-platform.json).

## PATCH /rest/v1/destinations/{id}

Partially update a destination. Only the fields you send are changed; omitted fields are unchanged. The `settings` object is patch-only: omitted keys keep their current value, and send `null` to clear a specific setting. Requires API-key scope or current OAuth user permission: destination:update

Request URL: `PATCH https://app.oursprivacy.com/rest/v1/destinations/{id}`

Authentication: apiKey or oauth2.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `id` | path | string | Yes |  |

### Request body (`application/json`, required)

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string \| null | No | Updated human-readable label. |
| `status` | string \| null | No | Set `Enabled` to resume dispatch or `Disabled` to pause. Omit or send `null` to keep the current status. One of: `"Enabled"`, `"Disabled"`, `null`. |
| `hashingSalt` | string \| null | No | Optional salt used when hashing PII fields before dispatch. |
| `limitedToSourceIds` | (string (uuid))[] \| null | No | Restrict dispatch to these source IDs. Omit on create or send `null` to accept every source. Unknown or other-account source IDs are dropped and duplicates are removed. An empty list, including one left after filtering, receives events from no source. |
| `settings` | object \| null | No | Per-type configuration keys and values. Call GET /rest/v1/destinations/types to discover valid keys. On PATCH, omitted keys are preserved and `null` clears a specific setting. |
| `id` | string | No | Server-assigned read-only field. Accepted on PATCH and ignored to support GET -> PATCH round-trips. |
| `createdAt` | string | No | Server-assigned read-only field. Accepted on PATCH and ignored to support GET -> PATCH round-trips. |
| `updatedAt` | string \| null | No | Server-assigned read-only field. Accepted on PATCH and ignored to support GET -> PATCH round-trips. |
| `type` | string | No | Server-assigned read-only field. Accepted on PATCH and ignored to support GET -> PATCH round-trips. One of: `"AWSEventBridge"`, `"AWSKinesis"`, `"AWSLambda"`, `"AWSS3"`, `"AWSSNS"`, `"ActiveCampaignApi"`, `"AdRollCAPI"`, `"Admitad"`, `"AdobeAnalytics"`, `"Affiliatly"`, `"AmazonDSP"`, `"Amplitude"`, `"AppLovin"`, `"ArtsAI"`, `"Attentive"`, `"Audiohook"`, `"AzureBlob"`, `"BasisPostback"`, `"BeeswaxPostback"`, `"BingAds"`, `"BingAdsWeb"`, `"BingRest"`, `"Braze"`, `"BrazeAudience"`, `"ConvertABTestingEvent"`, `"Customerio"`, `"DatabricksWarehouse"`, `"DomoWarehouse"`, `"Everflow"`, `"Facebook"`, `"FacebookAudience"`, `"FloodlightSGTM"`, `"FullContact"`, `"Fullstory"`, `"G4Analytics"`, `"GA4MeasurementProtocol"`, `"GA4ServerProxy"`, `"Google"`, `"GoogleAds360"`, `"GoogleAdsServerContainer"`, `"GoogleAudience"`, `"GoogleBigQuery"`, `"GoogleBigQueryWarehouse"`, `"GoogleDataManagerEventIngest"`, `"GooglePubSub"`, `"GoogleStorage"`, `"GravityCAPI"`, `"GrowthChannel"`, `"HTTPCustomRequest"`, `"HTTPDestination"`, `"Hubspot"`, `"IHeartMediaMagellan"`, `"Impact"`, `"Iterable"`, `"Katalys"`, `"Klaviyo"`, `"LeadSquared"`, `"LinkedInAdsCAPI"`, `"LiveIntent"`, `"LiveRampWarehouse"`, `"MNTN"`, `"MNTNAudience"`, `"Mailchimp"`, `"MailchimpAudience"`, `"MicrosoftCAPI"`, `"Mixpanel"`, `"NextdoorAds"`, `"OpenAIAds"`, `"OursSyntheticData"`, `"Outbrain"`, `"Partnerize"`, `"Pinterest"`, `"Plausible"`, `"Podscribe"`, `"PostHog"`, `"QuantcastCAPI"`, `"QuoraAds"`, `"Reddit"`, `"RedditCapiV3"`, `"Rokt"`, `"RokuCAPI"`, `"SnapchatAdsCapi"`, `"Spotify"`, `"StackAdaptAPI"`, `"Taboola"`, `"Tatari"`, `"TatariCAPI"`, `"TheTradeDesk"`, `"TikTok"`, `"Trybe"`, `"UniversalAds"`, `"VWO"`, `"Viant"`, `"ViantCAPI"`, `"Vibe"`, `"VibeAudience"`, `"Woopra"`, `"XAds"`, `"XAdsV2"`, `"YelpCAPI"`, `"Zendesk"`, `"ZohoCRM"`, `"ZoomInfo"`. |

### Responses

- `200`: Updated destination
- `400`: Bad Request
- `401`: Unauthorized — missing, invalid, or expired API key or OAuth access token
- `403`: Forbidden — credential does not have the required current Ours permission
- `404`: Not Found
- `500`: Internal Server Error

#### `200` response body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes |  |
| `name` | string \| null | No |  |
| `type` | string | Yes | Destination type. Read responses may include warehouse, cloud-storage, and audience-sync types that are not creatable through POST /rest/v1/destinations. One of: `"AWSEventBridge"`, `"AWSKinesis"`, `"AWSLambda"`, `"AWSS3"`, `"AWSSNS"`, `"ActiveCampaignApi"`, `"AdRollCAPI"`, `"Admitad"`, `"AdobeAnalytics"`, `"Affiliatly"`, `"AmazonDSP"`, `"Amplitude"`, `"AppLovin"`, `"ArtsAI"`, `"Attentive"`, `"Audiohook"`, `"AzureBlob"`, `"BasisPostback"`, `"BeeswaxPostback"`, `"BingAds"`, `"BingAdsWeb"`, `"BingRest"`, `"Braze"`, `"BrazeAudience"`, `"ConvertABTestingEvent"`, `"Customerio"`, `"DatabricksWarehouse"`, `"DomoWarehouse"`, `"Everflow"`, `"Facebook"`, `"FacebookAudience"`, `"FloodlightSGTM"`, `"FullContact"`, `"Fullstory"`, `"G4Analytics"`, `"GA4MeasurementProtocol"`, `"GA4ServerProxy"`, `"Google"`, `"GoogleAds360"`, `"GoogleAdsServerContainer"`, `"GoogleAudience"`, `"GoogleBigQuery"`, `"GoogleBigQueryWarehouse"`, `"GoogleDataManagerEventIngest"`, `"GooglePubSub"`, `"GoogleStorage"`, `"GravityCAPI"`, `"GrowthChannel"`, `"HTTPCustomRequest"`, `"HTTPDestination"`, `"Hubspot"`, `"IHeartMediaMagellan"`, `"Impact"`, `"Iterable"`, `"Katalys"`, `"Klaviyo"`, `"LeadSquared"`, `"LinkedInAdsCAPI"`, `"LiveIntent"`, `"LiveRampWarehouse"`, `"MNTN"`, `"MNTNAudience"`, `"Mailchimp"`, `"MailchimpAudience"`, `"MicrosoftCAPI"`, `"Mixpanel"`, `"NextdoorAds"`, `"OpenAIAds"`, `"OursSyntheticData"`, `"Outbrain"`, `"Partnerize"`, `"Pinterest"`, `"Plausible"`, `"Podscribe"`, `"PostHog"`, `"QuantcastCAPI"`, `"QuoraAds"`, `"Reddit"`, `"RedditCapiV3"`, `"Rokt"`, `"RokuCAPI"`, `"SnapchatAdsCapi"`, `"Spotify"`, `"StackAdaptAPI"`, `"Taboola"`, `"Tatari"`, `"TatariCAPI"`, `"TheTradeDesk"`, `"TikTok"`, `"Trybe"`, `"UniversalAds"`, `"VWO"`, `"Viant"`, `"ViantCAPI"`, `"Vibe"`, `"VibeAudience"`, `"Woopra"`, `"XAds"`, `"XAdsV2"`, `"YelpCAPI"`, `"Zendesk"`, `"ZohoCRM"`, `"ZoomInfo"`. |
| `status` | string | Yes | One of: `"Disabled"`, `"Enabled"`. |
| `createdAt` | string | Yes |  |
| `updatedAt` | string \| null | No |  |
| `settings` | object \| null | No |  |
| `limitedToSourceIds` | string[] \| null | No |  |
| `hashingSalt` | string \| null | No |  |

Full schema: [OpenAPI specification](https://docs.oursprivacy.com/openapi-platform.json).

## DELETE /rest/v1/destinations/{id}

Delete a destination. Requires API-key scope or current OAuth user permission: destination:delete

Request URL: `DELETE https://app.oursprivacy.com/rest/v1/destinations/{id}`

Authentication: apiKey or oauth2.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `id` | path | string | Yes |  |

### Responses

- `200`: Deleted successfully
- `400`: Bad Request
- `401`: Unauthorized — missing, invalid, or expired API key or OAuth access token
- `403`: Forbidden — credential does not have the required current Ours permission
- `404`: Not Found
- `500`: Internal Server Error

Full schema: [OpenAPI specification](https://docs.oursprivacy.com/openapi-platform.json).
