Remove Contacts from Group

Remove multiple contacts from a group. Contacts not in the group are silently skipped

Required Scope

groups:write

Behavior

Each contact's group_id JSON array is updated to remove this group ID
Contacts not in the group are silently skipped (not counted in contacts_removed)
Only contacts belonging to the current tenant are processed

Response

Success (200 OK): Returns the group ID and count of contacts actually removed

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Header Params

Body Params application/jsonRequired

Example

{
    "contact_ids": [
        123,
        124,
        125
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

Example

{
    "success": true,
    "data": {
        "group_id": 0,
        "contacts_removed": 0
    },
    "meta": {
        "request_id": "string",
        "timestamp": "string"
    }
}

🟠401UNAUTHORIZED

🟠403INSUFFICIENT_SCOPE

🟠403FEATURE_LIMIT_EXCEEDED

🟠404NOT_FOUND

🟠422VALIDATION_ERROR

🟠422WHATSAPP_NOT_CONFIGURED

🟠429RATE_LIMIT_EXCEEDED

🔴500INTERNAL_ERROR

Remove Contacts from Group

Remove multiple contacts from a group. Contacts not in the group are silently skipped#

Required Scope#

Behavior#