Pular para o conteúdo principal
GET
/
instances
/
{instanceId}
/
token
/
{token}
/
business
/
available-categories
Listar categorias
curl --request GET \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/business/available-categories \
  --header 'Client-Token: <api-key>'
{
  "displayName": "<string>",
  "label": "<string>",
  "id": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://developer.z-api.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Conceituação

Este método é responsável por listar todas as categorias disponíveis para configuração no perfil do WhatsApp Business.

​
Atributos

​
instanceId
string
obrigatório
ID da sua instância. Disponível no painel Z-API em Instâncias.
​
token
string
obrigatório
Token da sua instância Z-API.

​
Query Parameters

​
query
string
Busca por categoria

​
Response

​
200

​
displayName
string
Nome de exibição da categoria
​
label
string
Label da categoria
​
id
string
ID da categoria
[
  {
    "displayName": "Outras empresas",
    "label": "OTHER_COMPANIES",
    "id": "629412378414563"
  }
]

​
405

Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja verifique se você enviou o POST ou GET conforme especificado no início 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”.