Mon-Fri 10am - 6pm
Add Opt-out
Base URL for your account: https://cpaas.studio
POST
/api/whatsapp/v1/optouts
Record an opt-out (marketing = marketing templates blocked; all = every message you start).
Parameters
| Param | Type | Required | Notes |
|---|---|---|---|
phone |
string | yes | |
scope |
string | no | marketing (default) or all. |
channel |
string | no |
Request example
curl -X POST "https://cpaas.studio/api/whatsapp/v1/optouts" \
-H "X-API-KEY: cpk_xxxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
-H "Content-Type: application/json" \
-d '{"channel":"WCH54DZ7M7M5V","phone":"+919876543210","scope":"marketing"}'
Success response (data)
{
"phone": "+919876543210"
}
Need more context? See Getting started for authentication, the response envelope, and the full error-code reference.