Skip to main content
POST
Record consent for a contact on a channel

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Path Parameters

id
string
required

Body

application/json
channel
enum<string>
required

Channel the consent applies to.

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

Scope of the grant. Defaults to marketing.

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

How consent was captured. Defaults to api.

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

Optional IPv4/IPv6 address captured at opt-in.

metadata
object

Optional free-form evidence, under 8 KB when serialised.

Response

201 - application/json

The consent record that was created.

data
object

A single stored consent record for a contact on one channel, including its grant state and audit metadata.

meta
object