Desvincular grupos
Método#
/communities/unlink#
POST https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/communities/unlink
Header#
| Key | Value |
|---|---|
| Client-Token | TOKEN DE SEGURANÇA DA CONTA |
Conceituação#
Com essa API você consegue remover grupos de uma comunidade, para isso você vai precisar do ID da sua comunidade e os telefones dos grupos que deseja remover.
Atenção
Uma comunidade deve ter no mínimo 1 grupo vinculado a ela, isso sem contar com o grupo de avisos, então caso sua comunidade só possua um grupo comum vinculado, não será possível remove-lo.
Atributos#
Obrigatórios#
| Atributos | Tipo | Descrição |
|---|---|---|
| communityId | string | ID da comunidade que será desvinculado os grupos |
| groupsPhones | array string | Array com os número(s) dos grupos a serem desvinculados |
Opcionais#
| Atributos | Tipo | Descrição |
|---|
Request Body#
URL#
POST https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/communities/unlink
Body#
Response#
200#
| Atributos | Tipo | Descrição |
|---|---|---|
| success | boolean | true caso tenha dado certo e false em caso de falha |
Exemplo
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"