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.

Update a destination

このページはまだあなたの言語に翻訳されていません。 現在取り組んでいますので、後でもう一度確認してください。

patch/v1/projects/{project_id}/destinations/{id}

Authorizations

Authorizationstringrequired

http

Path parameters

project_idstringrequired

Amplitude project identifier, backed by the canonical app ID.

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

Destination id.

Constraints:min length: 1

Query parameters

dry_runboolean

Validate request without performing mutation.

Default:false

Header parameters

If-Matchinteger

Optimistic concurrency token. Must equal the resource version for the write to proceed; otherwise the API returns 412.

Constraints:min: 0

Body

application/json
event_filteroneOf
Constraints:objectnull
Show child attributes
eventsstring[]
property_filtersobject
property_mappingsoneOf
Constraints:objectnull
Other properties6
display_namestring
kindstring[]
configobject
enabledboolean
send_eventsboolean
send_usersboolean

Response

application/json
200· Destination updated, or dry-run plan.
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
planobject
Show child attributes
actionstringrequired
Allowed values:createupdatenoop
dry_runbooleanrequired
diffoneOf
Constraints:objectnull
warningsstring[]

これは役に立ちましたか？