Skip to main content

Reject Participant

Method#

/reject-participant#

POST https://api.z-api.io/instances/YOUR_INSTANCE/token/YOUR_TOKEN/reject-participant

Header#

KeyValue
Client-TokenACCOUNT SECURITY TOKEN

Concept#

This method is responsible for rejecting the entry of participants into the group.

Atenção

On November 4, 2021, WhatsApp changed the format for creating new groups. Previously: "phone": "5511999999999-1623281429," and now: "phone": "120363019502650977-group"


Attributes#

Required#

AttributesTypeDescription
groupIdstringGroup ID/phone
phonesarray stringArray with the number(s) of the participant(s) to be accepted.

Optionals#

AttributesTypeDescription

Request Body#

URL#

POST https://api.z-api.io/instances/YOUR_INSTANCE/token/YOUR_TOKEN/reject-participant

Body#

Old format -
{
"groupId": "5511999999999-1623281429",
"phones": ["5544999999999", "5544888888888"]
}
-------------------------------------------------
New format -
{
"groupId": "120363019502650977-group",
"phones": ["5544999999999", "5544888888888"]
}

Response#

200#

AttributesTypeDescription
valuebooleantrue if successful, and false if there is a failure.

Example

{
"value": true
}

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)

Webhook


Code#