Skip to main content
POST
Opt a contact out of a channel

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Body

application/json
contact
string

Contact identifier — phone (E.164) or email.

channel
string

Channel to suppress (sms, email, whatsapp, voice, rcs, …); case-insensitive.

reason
string

Why the contact opted out (1-500 chars).

Response

The contact was already opted out — data.already_opted_out is true and no new audit entry or webhook fired.

data
object
meta
object