Pular para o conteúdo principal

Configurações da comunidade

Método#

/communities/settings#

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

Header#

KeyValue
Client-TokenTOKEN DE SEGURANÇA DA CONTA

Conceituação#

Com essa API você consegue alterar as configurações de uma comunidade.

Atributos#

Obrigatórios#

AtributosTipoDescrição
communityIdstringID da comunidade que será alterado as configurações
whoCanAddNewGroupsstring (admins ou all)Configuração de quem pode adicionar novos grupos a essa comunidade. Somente administradores (admins) ou todos (all)

Request Body#

URL#

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

Body#

{
"communityId": "98372465382764532938",
"whoCanAddNewGroups": "admins" | "all"
}

Response#

200#

AtributosTipoDescrição
successbooleantrue caso tenha dado certo e false em caso de falha

Exemplo

{
"success": 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#