Pular para o conteúdo

Tags

Base path: /api/v1/tags Scopes: tags:read | tags:write

Tags são labels reutilizáveis pra organizar contatos, empresas e deals (ex: “Hot Lead”, “Cliente VIP”, “Black Friday 2026”). Cada tag tem nome + cor.

Lista tags

GET /api/v1/tags

Scope: tags:read

ParamTipoDescrição
searchstringBusca por nome
Terminal window
curl https://app.indutivacrm.com.br/api/v1/tags \
-H "X-API-Key: crm_live_..."
[
{
"id": "ckl4t01...",
"name": "Hot Lead",
"color": "#ef4444",
"createdAt": "2026-01-15T10:00:00.000Z"
},
{
"id": "ckl4t02...",
"name": "Cliente VIP",
"color": "#a855f7",
"createdAt": "2026-02-20T14:30:00.000Z"
}
]

Busca uma tag

GET /api/v1/tags/:id

Scope: tags:read

Cria uma tag

POST /api/v1/tags

Scope: tags:write

CampoTipoObrigatórioDescrição
namestringNome (único por tenant, case-insensitive)
colorstringHex #rrggbb. Default vermelho do tema
Terminal window
curl -X POST https://app.indutivacrm.com.br/api/v1/tags \
-H "X-API-Key: crm_live_..." \
-H "Content-Type: application/json" \
-d '{"name": "Black Friday 2026", "color": "#f59e0b"}'

Atualiza uma tag

PATCH /api/v1/tags/:id

Scope: tags:write

Terminal window
curl -X PATCH https://app.indutivacrm.com.br/api/v1/tags/ckl4t01... \
-H "X-API-Key: crm_live_..." \
-H "Content-Type: application/json" \
-d '{"color": "#10b981"}'

Deleta uma tag

DELETE /api/v1/tags/:id

Scope: tags:write

Remove a tag e suas associações com contatos/empresas/deals. Os registros associados não são deletados — só perdem a tag.

Resposta 204 No Content.

Vincular a um contato/empresa/deal

Para vincular uma tag a um contato existente, use os endpoints do recurso correspondente passando o id da tag em tags: [...]. Exemplo:

Terminal window
# Adiciona tag ao criar contato
curl -X POST https://app.indutivacrm.com.br/api/v1/contacts \
-H "X-API-Key: crm_live_..." \
-H "Content-Type: application/json" \
-d '{
"firstName": "Maria",
"email": "maria@empresa.com.br",
"tags": ["ckl4t01..."]
}'

Erros específicos

StatuserrorCenário
409duplicate_nameJá existe tag com mesmo nome no tenant
400validation_failedname ausente ou color em formato inválido
404not_foundid não existe