Pular para o conteúdo principal

Atribuir categorias

Método#

/business/categories#

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

Header#

KeyValue
Client-TokenTOKEN DE SEGURANÇA DA CONTA

Conceituação#

Através deste método, é possível atribuir categorias a empresa / compania.

Importante

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

Atenção

É possível cadastrar no máximo 3 categorias para a empresa, e é necessário que tenha no minímo uma.


Atributos#

Obrigatório#

AtributosTipoDescrição
categoriesarray stringId ou label da categoria a ser atribuída. Pode ser obtido na API de Listar categorias

Request Body#

{
"categories": ["RESTAURANT", "FINANCE", "629412378414563"]
}
Importante

Os valores enviados no atributo "categories" devem ser iguais aos retornados na requisição de "Listar categorias", na propriedade "id" ou "label". A propriedade "id" é útil quando a "label" não for retornada. Somente dessa forma é possível identificar a categoria desejada para ser atribuída.

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#