Pular para o conteúdo principal

Listar categorias

Método#

/business/available-categories?query={{STRING_DE_BUSCA (opcional)}}#

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

Header#

KeyValue
Client-TokenTOKEN DE SEGURANÇA DA CONTA

Conceituação#

Através deste método, é possível listar as categorias disponíveis para atribuir a empresa / compania.

Importante

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


Atributos#

Opcionais#

AtributosTipoDescrição
querystringParâmetro de pesquisa de categorias. Exemplo: "tecnologia"

Request Params#

URL exemplo#

Método

GET https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/business/available-categories?query=tecnologia

Response#

200#

AtributosTipoDescrição
displayNamestringNome da categorias a ser exibido
idstringIdentificador da categoria. Deve ser enviado na requisição de atribuir categorias a empresa
label(Opcional) stringTambém pode ser informado na requisição de atribuir categorias a empresa

Exemplo

[
{
"displayName": "Outras empresas",
"label": "OTHER_COMPANIES",
"id": "629412378414563"
},
{
"displayName": "Serviço automotivo",
"id": "1223524174334504"
}
]

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#