Skip to main content
POST
Create an opt-out

Authorizations

apiKey
string
header
required

Body

application/json
identifier
string
required

Phone number to opt out, in E.164 format

Example:

"+14155550100"

inboxId
string

Optional inbox ID for an inbox-scoped opt-out. When omitted, a team-wide opt-out is created. Requires the InboxOptOuts feature.

Example:

"00000000-0000-0000-0000-000000000000"

reason
string

Optional reason for the opt-out

Example:

"Customer requested via support"

Response

The created or existing opt-out

data
object
required