Pular para o conteúdo principal

Alterar descrição da empresa

Método#

/business/company-description#

POST https://api.z-api.io/instances/{{instanceId}}/token/{{instanceToken}}/business/company-description

Header#

KeyValue
Client-TokenTOKEN DE SEGURANÇA DA CONTA

Conceituação#

Através deste método, é possível alterar a descrição da empresa / compania.

Importante

Este método está disponível apenas para contas Business do whatsapp.


Atributos#

Opcional#

AtributosTipoDescrição
valuestringDescrição da empresa

Request Body#

{
"value": "Texto da descrição"
}
Dica

Para remover a descrição basta enviar o atributo "value" como vazio


Response#

201#

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 PUT 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#