For AI agents: a documentation index is available at /docs/llms.txt. Append .md to any page URL for markdown, or send Accept: text/markdown.

Create a destination

Always creates a new destination; the server assigns the id used for
every subsequent lookup. display_name is not an identity key, so
repeating a create makes another destination. When dry_run=true, returns
a plan envelope without mutating. SECRET/OAUTH config values are
write-only.

post/v1/projects/{project_id}/destinations

Authorizations

Authorizationstringrequired

http

Path parameters

project_idstringrequired

Amplitude project identifier, backed by the canonical app ID.

Example:12345
Constraints:pattern: ^[0-9]+$

Query parameters

dry_runboolean

Validate request without performing mutation.

Default:false

Body

application/json
partnerstringrequired
display_namestringrequired
Constraints:min length: 1
kindstring[]

Optional connector kinds. When omitted, the kind is inferred from the partner's capabilities; a multi-capability partner with no kind is rejected as ambiguous. When provided it is authoritative and validated against the partner. The three families are mutually exclusive: a subset of [event, identify], or [cohort], or [warehouse_export] — never combined.

event_filterobject
Show child attributes
eventsstring[]required
property_filtersobject
Other properties5
configobject
enabledboolean
property_mappingsobject
send_eventsboolean
send_usersboolean

Response

application/json
200· Dry-run plan (no mutation).
dataobjectrequired
Show child attributes
idstringrequired

Server-assigned identifier (read-only).

objectstringrequired
project_idstringrequired
Constraints:pattern: ^[0-9]+$
partnerstringrequired
display_namestringrequired
kindstring[]required
configobjectrequired

Partner config keyed by parameter id. SECRET/OAUTH values are write-only and never returned on reads. Values are scalars or structured (objects/arrays, e.g. header maps); structured values round-trip as decoded JSON.

credential_statusstringrequired
Allowed values:connecteddisconnectedexpired
versionintegerrequired
Constraints:min: 1
enabledboolean

Event-streaming only. Whether the stream is enabled.

pausedboolean

Event-streaming only. Whether the stream is paused.

event_filteroneOf

Event-streaming only. Events (and optional property filters) to stream.

Constraints:objectnull
eventsstring[]
property_filtersobject
property_mappingsoneOf

Event-streaming only. Optional property mappings.

Constraints:objectnull
send_eventsboolean

Event-streaming only. Whether to send events.

send_usersboolean

Event-streaming only. Whether to send identify/user updates.

created_atstringrequired
Constraints:format: date-time
updated_atstringrequired
Constraints:format: date-time
created_bystring
Constraints:nullable
updated_bystring
Constraints:nullable
planobjectrequired
Show child attributes
actionstringrequired
Allowed values:createupdatenoop
dry_runbooleanrequired
diffoneOf
Constraints:objectnull
warningsstring[]
201· Destination created.
dataobjectrequired
Show child attributes
idstringrequired

Server-assigned identifier (read-only).

objectstringrequired
project_idstringrequired
Constraints:pattern: ^[0-9]+$
partnerstringrequired
display_namestringrequired
kindstring[]required
configobjectrequired

Partner config keyed by parameter id. SECRET/OAUTH values are write-only and never returned on reads. Values are scalars or structured (objects/arrays, e.g. header maps); structured values round-trip as decoded JSON.

credential_statusstringrequired
Allowed values:connecteddisconnectedexpired
versionintegerrequired
Constraints:min: 1
enabledboolean

Event-streaming only. Whether the stream is enabled.

pausedboolean

Event-streaming only. Whether the stream is paused.

event_filteroneOf

Event-streaming only. Events (and optional property filters) to stream.

Constraints:objectnull
eventsstring[]
property_filtersobject
property_mappingsoneOf

Event-streaming only. Optional property mappings.

Constraints:objectnull
send_eventsboolean

Event-streaming only. Whether to send events.

send_usersboolean

Event-streaming only. Whether to send identify/user updates.

created_atstringrequired
Constraints:format: date-time
updated_atstringrequired
Constraints:format: date-time
created_bystring
Constraints:nullable
updated_bystring
Constraints:nullable

Was this helpful?