Skip to main content
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
remove-participant
Remove participants
curl --request POST \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/remove-participant \
  --header 'Client-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "groupId": "<string>",
  "phones": [
    {}
  ]
}
'

​
Overview

This method is responsible for removing participants from a group.

​
Attributes

​
instanceId
string
required
Your instance ID. Available in the Z-API panel under Instances.
​
token
string
required
Your Z-API instance token.

​
Required

​
groupId
string
required
Group ID/Phone
​
phones
array
required
Array with the phone numbers of participants to be removed

​
Request Body

{
  "groupId": "120363019502650977-group",
  "phones": ["5544999999999", "5544888888888"]
}

​
Response

​
200

{
  "value": true
}

​
405

Make sure you are correctly sending the method specification, that is, verify that you sent POST or GET as specified at the beginning of this topic.

​
415

If you receive a 415 error, make sure to add the “Content-Type” header to your request, which in most cases is “application/json”.