Documentation Index
Fetch the complete documentation index at: https://docs.lfautomatiza.com/llms.txt
Use this file to discover all available pages before exploring further.
Labels (também chamadas de tags ou etiquetas) são marcadores reutilizáveis para
organizar conversas e contatos. Cada label tem cor própria e pode aparecer em
filtros, automações e relatórios.
Listar labels
GET /api/v1/accounts/{account_id}/labels
curl https://chat.lfautomatiza.com/api/v1/accounts/1/labels \
-H "api_access_token: $TOKEN"
Resposta
{
"payload": [
{
"id": 1,
"title": "financeiro",
"description": "Tickets relacionados a boleto, NF, pagamento",
"color": "#9333ea",
"show_on_sidebar": true
},
{
"id": 2,
"title": "vip",
"color": "#f59e0b",
"show_on_sidebar": true
}
]
}
Criar label
POST /api/v1/accounts/{account_id}/labels
| Campo | Tipo | Obrigatório | Descrição |
|---|
title | string | ✅ | Nome da label (sem espaço, lowercase recomendado) |
description | string | | Tooltip / contexto |
color | string | | Hex (ex: #00B86B) |
show_on_sidebar | boolean | | Aparece como atalho no menu lateral |
curl -X POST https://chat.lfautomatiza.com/api/v1/accounts/1/labels \
-H "api_access_token: $TOKEN" \
-d '{
"title": "urgente",
"description": "Casos que precisam de SLA <30min",
"color": "#dc2626",
"show_on_sidebar": true
}'
Detalhe / atualizar / excluir
GET /api/v1/accounts/{account_id}/labels/{id}
PATCH /api/v1/accounts/{account_id}/labels/{id}
DELETE /api/v1/accounts/{account_id}/labels/{id}
Excluir uma label remove ela de todas as conversas e contatos que estavam marcados.
Não há “undo” — considere arquivar (renomear pra _zarchive_xxx) em vez de excluir.
Aplicar label numa conversa
Não use o endpoint /labels direto pra isso — use o endpoint de conversa:
POST /api/v1/accounts/{account_id}/conversations/{id}/labels
curl -X POST https://chat.lfautomatiza.com/api/v1/accounts/1/conversations/1287/labels \
-H "api_access_token: $TOKEN" \
-d '{ "labels": ["financeiro", "vip"] }'
Aplicar label num contato
POST /api/v1/accounts/{account_id}/contacts/{id}/labels
Filtrar conversas por label
curl "https://chat.lfautomatiza.com/api/v1/accounts/1/conversations?labels[]=vip&labels[]=urgente" \
-H "api_access_token: $TOKEN"
Códigos de resposta
| Código | Quando acontece |
|---|
200 OK | Listagem / leitura |
201 Created | Label criada |
204 No Content | Excluído com sucesso |
422 Unprocessable Entity | Título já existe na conta |
