Skip to main content
POST
Set or clear per-channel WhatsApp opt-out

Authorizations

Authorization
string
header
required

Organization API key (flo_…). Paste the full key; Scalar sends Authorization: Bearer <key>.

Body

application/json
action
enum<string>
required
Available options:
set
whatsappChannelId
string<cuid>
required
phone
string
required
Required string length: 3 - 32
reason
string
Maximum string length: 500

Response

Current opt-out state

optOutId
string | null
required
active
boolean
required
revokedAt
string | null
required
Last modified on August 8, 2026