v1

latestOpenAPI 3.0.02026-07-2491237338.9 KB
WhatsApp Groups

Remove group participants

Removes one or more participants from a WhatsApp group.

The request is processed asynchronously. Use webhooks to receive the final participants update result.

post/whatsapp/groups/{groupId}/participants/remove

Path parameters

groupIdstring required
Example:120363345678901234@g.us

WhatsApp group ID.

Request body

Example request

{
  "participants": [
    {
      "user": "16315551111",
      "fromUserId": "US.1234"
    }
  ]
}

Response

The participant removal request is successfully accepted.

requestIdstring

The request ID for tracking the asynchronous operation in webhooks.

status'pending'

The asynchronous request status.

Example response

{
  "requestId": "REQ_1",
  "status": "pending"
}