Alterar descrição
Método#
/update-community-description#
POST https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/update-community-description
Header#
| Key | Value |
|---|---|
| Client-Token | TOKEN DE SEGURANÇA DA CONTA |
Conceituação#
Este método permite você alterar a descrição da comunidade.
Atenção
Atenção somente administradores podem alterar as preferências da comunidade.
Atributos#
Obrigatórios#
| Atributos | Tipo | Descrição |
|---|---|---|
| communityId | string | ID/Fone do grupo |
| communityDescription | string | Atributo para alterar a descrição da comunidade |
Body#
Response#
200#
| Atributos | Tipo | Descrição |
|---|---|---|
| value | boolean | true caso tenha dado certo e false em caso de falha |
Exemplo
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"
Webhook Response#
Link para a response do webhook (ao receber)