Skip to main content
POST
cURL

Authorizations

X-API-Key
string
header
required

Path Parameters

groupId
string
required

WhatsApp group ID.

Example:

"120363345678901234@g.us"

Body

application/json
participants
object[]
required

Participants to remove. Up to 8 participants are supported in one request.

Maximum array length: 8

Response

The participant removal request is successfully accepted.

Response for asynchronous WhatsApp group operations.

requestId
string

The request ID for tracking the asynchronous operation in webhooks.

Example:

"REQ_1"

status
enum<string>

The asynchronous request status.

Available options:
pending
Example:

"pending"