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.
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:
Configuration changes at any stage take effect once you publish a new version.
A destination only receives an event if (1) an allowed event lists it on destinationIds, (2) no data-governance category stops dispatch, and (3) a mapping 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.
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>:
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:
{
"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. 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
Ours Privacy API key
In: header
Query Parameters
Maximum number of destinations to return. Defaults to 25; values below 1 are clamped to 1 and values above 200 are clamped to 200.
Opaque pagination cursor from pagination.nextCursor in the previous response. Do not decode or modify it. Malformed cursors return 400 Bad Request.
Filter destinations by status.
Value in
- "Disabled"
- "Enabled"
Filter destinations by destination type.
Value in
- "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"
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/rest/v1/destinations"{ "entities": [ { "id": "string", "name": "string", "type": "AWSEventBridge", "status": "Disabled", "createdAt": "string", "updatedAt": "string", "settings": { "property1": "string", "property2": "string" }, "limitedToSourceIds": [ "string" ], "hashingSalt": "string" } ], "pagination": { "nextCursor": "string", "hasMore": true }}POST/rest/v1/destinations
Ours Privacy API key
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/rest/v1/destinations" \ -H "Content-Type: application/json" \ -d '{ "type": "Audiohook" }'{ "id": "string", "name": "string", "type": "AWSEventBridge", "status": "Disabled", "createdAt": "string", "updatedAt": "string", "settings": { "property1": "string", "property2": "string" }, "limitedToSourceIds": [ "string" ], "hashingSalt": "string"}GET/rest/v1/destinations/types
Ours Privacy API key
In: header
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/rest/v1/destinations/types"{ "entities": [ { "id": "Audiohook", "label": "string", "status": "deprecated", "capabilities": { "oauth": true, "listsAccounts": true, "supportsRenamedEvents": true }, "settings": [ { "key": "string", "type": "Alert", "label": "string" } ] } ]}GET/rest/v1/destinations/{id}/health
Ours Privacy API key
In: header
Path Parameters
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/rest/v1/destinations/string/health"{ "status": "DEGRADED", "windowStart": "string", "windowEnd": "string", "totalDispatches": 0, "successCount": 0, "failureCount": 0, "stoppedCount": 0, "globalStopCount": 0, "successRate": 0, "lastDispatchedAt": "string"}GET/rest/v1/destinations/{id}
Ours Privacy API key
In: header
Path Parameters
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/rest/v1/destinations/string"{ "id": "string", "name": "string", "type": "AWSEventBridge", "status": "Disabled", "createdAt": "string", "updatedAt": "string", "settings": { "property1": "string", "property2": "string" }, "limitedToSourceIds": [ "string" ], "hashingSalt": "string"}PATCH/rest/v1/destinations/{id}
Ours Privacy API key
In: header
Path Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.com/rest/v1/destinations/string" \ -H "Content-Type: application/json" \ -d '{}'{ "id": "string", "name": "string", "type": "AWSEventBridge", "status": "Disabled", "createdAt": "string", "updatedAt": "string", "settings": { "property1": "string", "property2": "string" }, "limitedToSourceIds": [ "string" ], "hashingSalt": "string"}DELETE/rest/v1/destinations/{id}
Ours Privacy API key
In: header
Path Parameters
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X DELETE "https://example.com/rest/v1/destinations/string"trueHow is this guide?

