Update a destination
PATCH
/v1/destinations/{id}
Update editable fields on a destination — name and/or status. Setting status: paused HOLDS delivery (events are parked and drain on resume); active resumes.
Authorizations
apiKey
Scoped API key. Scopes are read ⊂ write ⊂ admin. A call needing more scope than the key holds returns 403 insufficient_scope.
Type
HTTP (bearer)
Parameters
Path Parameters
id*
Type
Requiredstring
Request Body
application/json
JSON "name": "acme-orders", "status": "paused", "config": { "payload": "raw", "method": "POST", "timeoutMs": 15000, "headers": { "additionalProperties": "string" } }
{
}
Responses
The updated destination.
application/json
JSON "id": "dst_01JX9", "name": "acme-orders", "type": "string", "validation": "pending", "status": "active", "version": 1
{
}