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

Conceituação

Com essa API você consegue adicionar outros grupos a uma comunidade.
Não é possível vincular o mesmo grupo em mais de uma comunidade. Se você enviar 3 grupos e 1 já pertencer a outra comunidade, 2 serão adicionados e o outro retornará um erro indicando que já faz parte de outra 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.

Obrigatórios

communityId
string
obrigatório
ID da comunidade
groupsPhones
array
obrigatório
Array com os IDs/Phones dos grupos a serem vinculados

Request Body

{
  "communityId": "98372465382764532938",
  "groupsPhones": ["1345353454354354-group", "1203634230225498-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”.