Pular para o conteúdo principal

Remover Participantes

Método#

/remove-participant#

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

Header#

KeyValue
Client-TokenTOKEN DE SEGURANÇA DA CONTA

Conceituação#

Este método é reponsável por remover participantes do grupo.

Atenção

No dia 4 de novembro de 2021 o whatsapp alterou a formato da criação de novos grupos, antes: "phone": "5511999999999-1623281429" agora: "phone": "120363019502650977-group"


Atributos#

Obrigatórios#

AtributosTipoDescrição
groupIdstringID/Fone do grupo
phonesarray stringArray com os número(s) do(s) participante(s) a serem removidos

Opcionais#

AtributosTipoDescrição

Request Body#

URL#

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

Body#

Forma antiga -
{
"groupId": "5511999999999-1623281429",
"phones": ["5544999999999", "5544888888888"]
}
-------------------------------------------------
Forma nova -
{
"groupId": "120363019502650977-group",
"phones": ["5544999999999", "5544888888888"]
}

Response#

200#

AtributosTipoDescrição
valuebooleantrue 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


Code#