API Bienna3

Appearance

🏷️ Tags, Origens e Segmentações ​

Os metadados ajudam você a classificar, segmentar e rastrear a origem dos seus Leads e Contatos.

Origens de Leads (Lead Sources) ​

Representam de onde o Lead veio (ex: Formulário do Site, WhatsApp, Feira de Eventos).

Listar Origens ​

GET /api/leadsources

Exemplo de Resposta ​

json
[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Padrão",
    "description": "Origem padrão do sistema",
    "color": "#6366f1"
  }
]

Dica: Utilize o id retornado aqui para preencher o campo sourceId ao criar um novo Lead.

Tags ​

Tags são etiquetas que podem ser fixadas em Leads, Contatos e Empresas para agrupamento livre.

Listar Tags Disponíveis ​

GET /api/tags

Associar uma Tag a um Registro (Lead/Contato/Empresa) ​

Você pode anexar uma Tag a uma entidade existente utilizando a rota de atribuição.

POST /api/tags/assign

json
{
  "entityType": "Lead",
  "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "tagId": "uuid-da-tag"
}

Os tipos suportados para entityType são: Lead, Contact, Customer, Campaign.

Remover Tag de um Registro ​

POST /api/tags/unassign

(Usa o mesmo corpo da requisição de atribuição).