Skip to main content
POST
Opt a contact out of a channel

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Headers

Idempotency-Key
string

Stripe-style idempotency token. Pass a stable, client-generated value (1-255 chars) to dedupe retries on transient timeouts. The same key+credential+path replays the original response for 24h on 2xx (5min on 4xx, 30s on 5xx). Returns 409 if a concurrent request with the same key is already in flight; replayed responses include the Idempotency-Replay: true response header.

Required string length: 1 - 255
X-Test-Mode
enum<string>

Sandbox opt-in for Clerk-session-authenticated requests — see Test mode explained for the full credential-header matrix and worked samples. 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

Body

application/json
contact
string

Contact identifier — phone (E.164) or email.

channel
string

Channel to suppress (sms, email, whatsapp, voice, rcs, …); case-insensitive.

reason
string

Why the contact opted out (1-500 chars).

Response

The contact was already opted out — data.already_opted_out is true and no new audit entry or webhook fired.

The contact was already opted out — data.already_opted_out is true and no new audit entry or webhook fired.

data
object
meta
object