Skip to main content
POST
Create call opt out

Authorizations

Authorization
string
header
required

Send your team API key or project token as Authorization: Bearer <token>. The credential must have the required permissions. Project tokens can access only their own project.

Body

application/json
phoneNumber
string
required

Phone number in E.164 format, for example +14155550123.

Value constraints

Pattern: ^\+[1-9]\d{1,14}$
bsuid
string

WhatsApp business-scoped user ID, for example US.13491208655302741918.

Value constraints

Pattern: ^[A-Z]{2}\.[A-Za-z0-9]{1,128}$
note
string

Optional note, 1 to 500 Unicode characters.

Value constraints

Required string length: 1 - 500

Response

The entry already existed.

success
enum<boolean>
required

Whether the request succeeded.

Allowed values

Available options:
true
data
object
required

Structured data carried by this object.