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

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

Antes de utilizar esse recurso, é importante verificar se o aplicativo do WhatsApp no seu celular já possui compatibilidade com as comunidades, caso já esteja disponível você pode utilizar essa API para criar novas comunidades.

​
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

​
name
string
obrigatório
Nome da comunidade

​
Opcionais

​
description
string
Descrição da comunidade

​
Request Body

{
  "name": "Minha primeira Comunidade"
}

​
Response

​
200

​
id
string
ID da comunidade criada
​
subGroups
array
Grupos vinculados à comunidade
{
  "id": "98372465382764532938",
  "subGroups": [
    {
      "name": "Minha primeira Comunidade",
      "phone": "342532456234453-group",
      "isGroupAnnouncement": 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”.