v1

latestOpenAPI 3.0.02026-07-2411724301.7 KB

Groups

Remove Participants

The Remove Participants API enables the removal of participants from a specified WhatsApp group.

delete/v2/{sid}/whatsapp/groups/{groupId}/participants

Path parameters

sidstring required

Account SID (Security Identifier).

groupIdstring required

Group ID of the WhatsApp group from which participants should be removed.

Request body

messaging_productstring required

To be passed as whatsapp

Example request

{
  "messaging_product": "whatsapp",
  "participants": [
    {
      "user": "91xxxxxxxxxx"
    }
  ]
}

Response

Participants removed successfully

codestring

messagestring

errorobject

Example response

{
  "code": "WA200",
  "message": "Request Processed Successfully",
  "data": {
    "messaging_product": "whatsapp",
    "request_id": "string"
  },
  "error": {}
}