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

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>
required

sms (also RCS, iMessage and Viber texts), whatsapp, voice (calls) or email.

Available options:
sms,
whatsapp,
voice,
email

Response

The result

blocked
boolean
required

True when a send to this address on this channel would be refused.