Skip to main content
POST
Typescript (SDK)

Authorizations

Authorization
string
header
required

API key in the format: Bearer {api_token}

Body

application/json
e164
string
purpose
enum<string>
Available options:
marketing,
transactional
Available options:
web_form,
checkout,
import,
verbal,
api,
other
timezone
string | null
customer
string | null

Customer ID

proof
object

Response

Consent recorded

id
string
required
object
string
required
e164
string
required
purpose
enum<string>
required
Available options:
marketing,
transactional
Available options:
web_form,
checkout,
import,
verbal,
api,
other
timezone
string | null
required
consented_at
string<date-time>
required
revoked_at
string<date-time> | null
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
customer
string | null
required