Skip to main content
POST
messaging.opt-out.add

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
address
string
required

A phone number with its country code (spaces and a leading 0 after it are fine), or an email address. Personal data.

Required string length: 1 - 320
channel
enum<string>
default:all

The channel the entry blocks, or all of them.

Available options:
sms,
whatsapp,
voice,
email,
all
reason
string

Why, for your own records.

Required string length: 1 - 200

Response

The result

optOutId
string
required

The entry's id.

addressHint
string
required

The start and end of the address, enough to recognise it; the rest is not kept.

channel
enum<string>
required

The channel the entry blocks, or all of them.

Available options:
sms,
whatsapp,
voice,
email,
all
source
enum<string>
required

builder_api: you added it. inbound_stop: the person replied STOP. unsubscribe_link: they used an email's unsubscribe link.

Available options:
builder_api,
inbound_stop,
platform_admin,
unsubscribe_link
createdAt
string
required

When it was added, ISO 8601.

reason
string

Why it was added.