Skip to main content
PATCH
Toggle a destination or change its dataset filter

Authorizations

hookie_session
string
cookie
required

The console's sealed session cookie, set by WorkOS AuthKit. Mutating requests also require the X-Requested-With CSRF header.

Path Parameters

pid
string
required

Project id (UUID) belonging to the caller workspace.

id
string
required

Destination id.

Body

application/json

At least one of enabled or dataset_filter. Name, URL and secret are immutable - a delivery signature is verified against the URL it was sent to.

enabled
boolean
dataset_filter
string[] | null

SNAKE_CASE on patch (create uses datasetFilter). null, or a list that dedupes to empty, means every dataset.

Maximum array length: 50
Pattern: ^[A-Za-z][A-Za-z0-9_]{0,62}$

Response

Updated.

ok
boolean
required