Pular para o conteúdo principal
GET
/
instances
/
{instanceId}
/
token
/
{token}
/
communities-metadata
/
{communityId}
Metadata da comunidade
curl --request GET \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/communities-metadata/{communityId} \
  --header 'Client-Token: <api-key>'
{
  "name": "<string>",
  "id": "<string>",
  "description": "<string>",
  "subGroups": [
    {
      "name": "<string>",
      "phone": "<string>",
      "isGroupAnnouncement": true
    }
  ]
}

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 retorna o metadata da comunidade, como nome, descrição e grupos vinculados.

​
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

​
name
string
Nome da comunidade
​
id
string
ID da comunidade
​
description
string
Descrição da comunidade
​
subGroups
array
Grupos vinculados à comunidade
{
  "name": "Minha primeira Comunidade",
  "id": "98372465382764532938",
  "description": "Uma descrição da comunidade",
  "subGroups": [
    {
      "name": "Minha primeira Comunidade",
      "phone": "342532456234453-group",
      "isGroupAnnouncement": true
    },
    {
      "name": "Outro grupo",
      "phone": "1203634230225498-group",
      "isGroupAnnouncement": false
    }
  ]
}

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