Remove Participants
Methods#
/add-participant#
POST https://api.z-api.io/instances/YOUR_INSTANCE/token/YOUR_TOKEN/remove-participant
Header#
| Key | Value |
|---|---|
| Client-Token | ACCOUNT SECURITY TOKEN |
Concept#
This method is responsible for removing members of the group
Attention
On November 4, 2021 whatsapp changed the format of creating new groups. before: "phone": "5511999999999-1623281429" now: "phone": "120363019502650977-group"
Attributes#
Required#
| Attributes | Type | Description |
|---|---|---|
| groupId | string | Group ID/phone |
| phones | array string | Array with the number(s) of the participant(s) to be removed |
Optionals#
| Attributes | Type | Description |
|---|
Request Body#
URL#
POST https://api.z-api.io/instances/YOUR_INSTANCE/token/YOUR_TOKEN/remove-participant
Body#
Response#
200#
| Attributes | Type | Description |
|---|---|---|
| value | boolean | true if it worked and false if it failed |
Example
405#
In this case certify that you are sending the correct specification of the method. This means, verify if you sent a POST or GET as specified at the beginning of this topic.
415#
In case you receive 415 error, make sure to add the “Content-Type” of the object you are sending in the request headers, mostly “application/json”
Webhook Response#
Link to webhook response (on receipt)