Skip to main content
flag
Mon - Fri   10:00 – 18:00

List Opt-outs

API Documentation / WhatsApp / List Opt-outs

Base URL for your account: https://cpaas.studio

GET /api/whatsapp/v1/optouts

Numbers that opted out, per number and scope.

No parameters.

Request example

curl -X GET "https://cpaas.studio/api/whatsapp/v1/optouts" \
  -H "X-API-KEY: cpk_xxxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Success response (data)

{
    "optouts": [
        {
            "channel": "WCH54DZ7M7M5V",
            "phone": "+919876543210",
            "scope": "marketing",
            "source": "keyword",
            "created_at": "2026-10-09T12:00:00+00:00"
        }
    ],
    "pagination": {
        "page": 1,
        "per_page": 50,
        "total": 1,
        "total_pages": 1
    }
}

Need more context? See Getting started for authentication, the response envelope, and the full error-code reference.