Skip to main content
POST
Record consent for a contact on 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

Path Parameters

id
string
required

ID of the contact the consent is recorded for.

Body

application/json
channel
enum<string>

Channel the consent applies to.

Available options:
sms,
whatsapp,
rcs,
viber,
email,
voice

Scope of the consent; defaults to marketing when omitted.

Available options:
marketing,
transactional,
all
source
enum<string>

How the opt-in was captured; defaults to api when omitted.

Available options:
web_form,
api,
import,
opt_in_keyword,
verbal
ip_address
string

IPv4 / IPv6 address captured at opt-in time as proof of consent.

metadata
object

Free-form proof-of-consent evidence (form id, campaign, …); under 8 KB.

Response

The created consent record, wrapped in the standard { data, meta } envelope.

The created consent record, wrapped in the standard { data, meta } envelope.

data
object
meta
object