Remover participantes

Método#

/remove-participant#

POST https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/remove-participant

Header#

Key	Value
Client-Token	TOKEN DE SEGURANÇA DA CONTA

Conceituação#

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

Atributos#

Obrigatórios#

Atributos	Tipo	Descrição
communityId	string	ID/Fone da comunidade. Pode ser obtido na API de Listar comunidades
phones	array string	Array com os número(s) do(s) participante(s) a serem removidos

Request Body#

URL#

POST https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/remove-participant

Body#

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

Response#

200#

Atributos	Tipo	Descrição
value	boolean	true caso tenha dado certo e false em caso de falha

Exemplo

{
  "value": true
}

405#

Neste caso certifique que esteja enviando o corretamente a especificação do método, ou seja verifique se você enviou o POST ou GET conforme especificado no inicio 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"

Webhook Response#

Link para a response do webhook (ao receber)

Webhook