Skip to main content
POST
Record contact consent

Authorizations

Authorization
string
header
required

Your API key, e.g. sk_live_... or sk_test_....

Headers

Idempotency-Key
string

Optional. Makes this write safe to retry: the same key replays the first response instead of acting twice.

Maximum string length: 255

Path Parameters

contact
string
required

Contact uuid or phone number.

Body

application/json
granted
boolean
default:true

Whether consent is granted or revoked.

channel
enum<string>
default:whatsapp
Available options:
whatsapp,
sms,
email
purpose
enum<string>
default:marketing
Available options:
marketing,
transactional,
all

What the person agreed to.

Maximum string length: 1000
proof_reference
string

Where the consent is recorded — a form id, URL or ticket number.

Maximum string length: 255
captured_by
string

Who captured it — a user id or system name.

Maximum string length: 255

Response

Consent updated.

uuid
string
channel
string
purpose
string
status
enum<string>
Available options:
granted,
revoked
consented_at
string<date-time> | null
revoked_at
string<date-time> | null