Pular para o conteúdo principal
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
communities
/
unlink
Desvincular grupos
curl --request POST \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/communities/unlink \
  --header 'Client-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "communityId": "<string>",
  "groupsPhones": [
    {}
  ]
}
'

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

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.
Uma comunidade precisa manter pelo menos 1 grupo vinculado (excluindo o grupo de avisos), então não é possível remover um grupo se ele for o único grupo comum vinculado.

​
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
​
groupsPhones
array
obrigatório
Array com os números dos grupos a serem desvinculados

​
Request Body

{
  "communityId": "98372465382764532938",
  "groupsPhones": ["1345353454354354-group"]
}

​
Response

​
200

{
  "success": 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”.