Pular para o conteúdo principal

Criar comunidade

Método#

/create-group#

POST https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/communities

Header#

KeyValue
Client-TokenTOKEN DE SEGURANÇA DA CONTA

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#

Obrigatórios#

AtributosTipoDescrição
namestringNome da comunidade que deseja criar

Opcionais#

AtributosTipoDescrição
descriptionstringDescrição da comunidade

Request Body#

Método

POST https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/communities

Exemplo

{
"name": "Minha primeira Comunidade"
}

Response#

200#

AtributosTipoDescrição
idstringID da comunidade criada
subGroupsarray[subgroup]Lista de grupos vinculados

Exemplo

{
"id": "98372465382764532938",
"subGroups": [
{
"name": "Minha primeira Comunidade",
"phone": "342532456234453-group",
"isGroupAnnouncement": true
}
]
}

405#

Neste caso certifique que esteja enviando o corretamente a especificação do método, ou seja verifique se você enviou o POST ou GET conforme especificado no inicio 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"


Code#