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

Remove Group Members

API Documentation / WhatsApp / Remove Group Members

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

DELETE /api/whatsapp/v1/groups/{uid}/members

Remove contacts from the group by phone.

No parameters.

Request example

curl -X DELETE "https://cpaas.studio/api/whatsapp/v1/groups/WGR4K7Q2M9X/members" \
  -H "X-API-KEY: cpk_xxxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{"phones":["+919876543210"]}'

Success response (data)

{
    "changed": 1,
    "matched": 1,
    "group": {
        "uid": "WGR4K7Q2M9X",
        "name": "Kerala customers",
        "description": null,
        "contacts_count": 1250
    }
}

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