Pular para o conteúdo principal
DELETE
/
instances
/
{instanceId}
/
token
/
{token}
/
communities
/
{communityId}
Desativar comunidade
curl --request DELETE \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/communities/{communityId} \
  --header 'Client-Token: <api-key>'

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 desativar uma comunidade.
Desativar a comunidade não excluirá seus grupos, mas sim os removerá 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.

​
Path

​
communityId
string
obrigatório
ID da comunidade

​
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”.