Skip to main content
GET
Listar etiquetas
Auth: TokenAccount ou TokenInstanceRate-limit: Global (100/min) • Idempotente: sim

Descrição

Retorna todas as etiquetas conhecidas pela instância, incluindo as criadas via API e as importadas via app state do WhatsApp. Cada etiqueta carrega um id, name, color (paleta nativa do WhatsApp), type e flag deleted.
color é um inteiro entre 0 e 10 que mapeia para as cores oficiais do WhatsApp Business. Tags marcadas com deleted=true ainda aparecem na listagem até o sync remover de vez.

Exemplo

Resposta de sucesso

tags é o array de etiquetas conhecidas pela conta WhatsApp Business; total ecoa o tamanho. Cada entrada traz id (use em tags-atribuir/tags-desatribuir/tags-deletar), name, color (0–10) e type. Etiquetas marcadas com deleted: true representam remoções pendentes de propagação.
200 OK

Parâmetros de rota

string
obrigatório
Nome da instância.

Headers

Respostas de erro

Erro 401

Relacionados

Criar etiqueta

POST /api/chat/tag/:instance

Atribuir a um chat

POST /api/chat/assignTag/:instance