Skip to main content
POST
/
api
/
v1
/
opt-outs
Set or clear per-channel WhatsApp opt-out
curl --request POST \
  --url https://app.flowella.io/api/v1/opt-outs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "action": "set",
  "whatsappChannelId": "clxxxxxxxxxxxxxxxxxxxxxxxx",
  "phone": "+15551234567",
  "reason": "User requested via CRM"
}
'
{
  "optOutId": "clxxxxxxxxxxxxxxxxxxxxxxxx",
  "active": true,
  "revokedAt": null
}

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