Skip to main content
PATCH
Update opt-out list

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Headers

X-Test-Mode
enum<string>

Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.

Available options:
true,
false

Path Parameters

id
string
required

Body

application/json
label
string
stop_keywords
string[]
help_keywords
string[]
start_keywords
string[]
stop_response
string | null
help_response
string | null
start_response
string | null
default_lang
enum<string> | null
Available options:
en,
tr,
de,
es,
fr,
pt,
it,
ar,
nl
brand
string | null

Response

The updated opt-out list with its full keyword and response-copy configuration, wrapped in the standard { data, meta } envelope.

The updated opt-out list with its full keyword and response-copy configuration, wrapped in the standard { data, meta } envelope.