Etiquetas (Tags)

Com a API de tags você pode gerenciar as tags da sua empresa e vinculá-las a contatos e chats para organização e segmentação.

Listar Tags

GET https://api.tinko.com.br/v1/tags

Retorna todas as tags da empresa autenticada.

Headers

Nome	Tipo	Obrigatório	Descrição
Authorization	string	Sim	Token de autenticação. Ex: Bearer seu_token

Query Parameters

Nome	Tipo	Obrigatório	Descrição
page	integer	Não	Número da página. Default: 1
per_page	integer	Não	Registros por página (máx: 100). Default: 50
search	string	Não	Buscar por texto da tag

Exemplo de requisição

curl -X GET "https://api.tinko.com.br/v1/tags?search=cliente" \
  -H "Authorization: Bearer SEU_TOKEN"

Response

{
  "success": true,
  "data": [
    {
      "id": "01j7m8n9p0q1r2s3t4u5v6w7x",
      "text": "Cliente VIP",
      "emoji": "⭐",
      "color": "#FFD700",
      "created_at": "2025-10-29T10:30:00.000000Z"
    },
    {
      "id": "01k8l9m0n1o2p3q4r5s6t7u8v9w",
      "text": "Cliente Novo",
      "emoji": "🆕",
      "color": "#4CAF50",
      "created_at": "2025-10-28T15:45:00.000000Z"
    }
  ],
  "pagination": {
    "total": 2,
    "per_page": 50,
    "current_page": 1,
    "last_page": 1
  }
}

Campos do Response

Campo	Tipo	Descrição
id	string	ID da tag
text	string	Texto da tag
emoji	string/null	Emoji da tag
color	string	Cor da tag em hexadecimal
created_at	string	Data de criação

Visualizar Tag

GET https://api.tinko.com.br/v1/tags/{id}

Retorna os detalhes de uma tag específica.

Headers

Nome	Tipo	Obrigatório	Descrição
Authorization	string	Sim	Token de autenticação. Ex: Bearer seu_token

Path Parameters

Nome	Tipo	Obrigatório	Descrição
id	string	Sim	ID da tag

Exemplo de requisição

curl -X GET "https://api.tinko.com.br/v1/tags/01j7m8n9p0q1r2s3t4u5v6w7x" \
  -H "Authorization: Bearer SEU_TOKEN"

Response

{
  "success": true,
  "data": {
    "id": "01j7m8n9p0q1r2s3t4u5v6w7x",
    "text": "Cliente VIP",
    "emoji": "⭐",
    "color": "#FFD700",
    "created_at": "2025-10-29T10:30:00.000000Z"
  }
}

Criar Tag

POST https://api.tinko.com.br/v1/tags

Cria uma nova tag.

Campo	Tipo	Obrigatório	Descrição
text	string	Sim	Texto da tag
emoji	string	Não	Emoji da tag
color	string	Não	Cor da tag em hexadecimal. Default: #000000

Exemplo de requisição

curl -X POST "https://api.tinko.com.br/v1/tags" \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "text": "Cliente VIP",
    "emoji": "⭐",
    "color": "#FFD700"
  }'

Response

{
  "success": true,
  "message": "Tag criada com sucesso.",
  "data": {
    "id": "01j7m8n9p0q1r2s3t4u5v6w7x",
    "text": "Cliente VIP",
    "emoji": "⭐",
    "color": "#FFD700",
    "created_at": "2025-10-29T10:30:00.000000Z"
  }
}

Erros

{
  "success": false,
  "message": "Erro de validação",
  "errors": [
    {
      "code": "FIELD_REQUIRED",
      "field": "text",
      "message": "O campo text é obrigatório."
    }
  ]
}

Atualizar Tag

PUT https://api.tinko.com.br/v1/tags/{id}

Atualiza os dados de uma tag existente.

Path Parameters

Nome	Tipo	Obrigatório	Descrição
id	string	Sim	ID da tag

Request Body

Campo	Tipo	Obrigatório	Descrição
text	string	Não	Texto da tag
emoji	string	Não	Emoji da tag
color	string	Não	Cor da tag em hexadecimal

Exemplo de requisição

curl -X PUT "https://api.tinko.com.br/v1/tags/01j7m8n9p0q1r2s3t4u5v6w7x" \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "text": "Cliente Premium",
    "color": "#C0A000"
  }'

Response

{
  "success": true,
  "message": "Tag atualizada com sucesso.",
  "data": {
    "id": "01j7m8n9p0q1r2s3t4u5v6w7x",
    "text": "Cliente Premium",
    "emoji": "⭐",
    "color": "#C0A000",
    "created_at": "2025-10-29T10:30:00.000000Z"
  }
}

Erros

{
  "success": false,
  "message": "Tag não encontrada."
}

Excluir Tag

DELETE https://api.tinko.com.br/v1/tags/{id}

Remove uma tag. A tag será desvinculada automaticamente de todos os contatos e chats.

Path Parameters

Nome	Tipo	Obrigatório	Descrição
id	string	Sim	ID da tag

Exemplo de requisição

curl -X DELETE "https://api.tinko.com.br/v1/tags/01j7m8n9p0q1r2s3t4u5v6w7x" \
  -H "Authorization: Bearer SEU_TOKEN"

Response

{
  "success": true,
  "message": "Tag excluída com sucesso."
}

Erros

{
  "success": false,
  "message": "Tag não encontrada."
}