Pular para o conteúdo principal
GET
Metadata da comunidade

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

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