Labels

Labels (etiquetas) classificam conversas e contatos — por exemplo vip, orcamento, pos-venda. Aqui você gerencia as labels da conta; aplicá-las é feito nas páginas de Conversas e Contatos.

Base e autenticação

As rotas desta página são relativas a /api/v1/accounts/{account_id} na base https://appchat01.interleads.chat e exigem o cabeçalho api_access_token.

Endpoints

Método	Rota	Descrição
GET	/labels	Lista todas as labels da conta
POST	/labels	Cria uma label
GET	/labels/{id}	Detalhes de uma label
PATCH	/labels/{id}	Atualiza uma label
DELETE	/labels/{id}	Exclui uma label

Criar uma label

Campos: title (obrigatório; sem espaços — use - ou _), description, color (hex), show_on_sidebar (booleano).

curl -X POST "https://appchat01.interleads.chat/api/v1/accounts/3/labels" \
  -H "api_access_token: $INTERLEADS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "vip",
    "description": "Clientes prioritários",
    "color": "#3479C7",
    "show_on_sidebar": true
  }'

Listar labels

curl "https://appchat01.interleads.chat/api/v1/accounts/3/labels" \
  -H "api_access_token: $INTERLEADS_TOKEN"

Aplicar a uma conversa ou contato

A criação da label e a aplicação dela são passos separados. Depois de criar, aplique:

• Em uma conversa: POST /conversations/{id}/labels com { "labels": ["vip"] } — veja Conversas.
• Em um contato: POST /contacts/{id}/labels com { "labels": ["vip"] } — veja Contatos.

O envio substitui o conjunto

Ao aplicar labels, você envia a lista completa desejada — as que não estiverem na lista são removidas daquele registro. Para adicionar uma sem perder as demais, envie o conjunto atual + a nova.

Erros comuns

Código	Significado
401	Token ausente ou inválido
404	Label não encontrada
422	title inválido (ex.: com espaços) ou duplicado