Pular para o conteúdo principal
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
remove-participant
Remover participantes
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 '
{
  "communityId": "<string>",
  "phones": [
    {}
  ]
}
'

Documentation Index

Fetch the complete documentation index at: https://developer.z-api.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Conceituação

Este método é responsável por remover participantes da comunidade.

​
Atributos

​
instanceId
string
obrigatório
ID da sua instância. Disponível no painel Z-API em Instâncias.
​
token
string
obrigatório
Token da sua instância Z-API.

​
Obrigatórios

​
communityId
string
obrigatório
ID da comunidade. Pode ser obtido na API de Listar comunidades
​
phones
array
obrigatório
Array com os números dos participantes a serem removidos

​
Request Body

{
  "communityId": "120363019502650977",
  "phones": ["5544999999999", "5544888888888"]
}

​
Response

​
200

{
  "value": true
}

​
405

Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja verifique se você enviou o POST ou GET conforme especificado no início deste tópico.

​
415

Caso você receba um erro 415, certifique de adicionar na headers da requisição o “Content-Type” do objeto que você está enviando, em sua grande maioria “application/json”.