# Etiquetas

> Crie e gerencie etiquetas para organizar as atividades

- Página: https://tbit.app/pt/docs/api/tags
- URL base: `https://rest-api.tbit.app/v1`
- Autenticação: cabeçalho `X-API-Key` com a sua chave em cada requisição (os exemplos a leem da variável de ambiente `TBIT_API_KEY`)

## Visão geral

As etiquetas permitem categorizar e organizar as atividades. Cada etiqueta tem um nome, uma cor opcional e uma descrição opcional. As etiquetas pertencem ao seu agente.

## Endpoints

| Método | Rota | Descrição |
| --- | --- | --- |
| `GET` | `/v1/tags` | Listar todas as etiquetas |
| `POST` | `/v1/tags` | Criar uma etiqueta |
| `PATCH` | `/v1/tags/:id` | Atualizar uma etiqueta |
| `DELETE` | `/v1/tags/:id` | Excluir uma etiqueta |

## Listar etiquetas

`GET /v1/tags`

```bash
curl "https://rest-api.tbit.app/v1/tags" \
  -H "X-API-Key: $TBIT_API_KEY"
```

## Criar etiqueta

`POST /v1/tags`

```bash
curl -X POST "https://rest-api.tbit.app/v1/tags" \
  -H "X-API-Key: $TBIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "VIP",
    "color": "#ef4444",
    "description": "High-priority customers"
  }'
```

## Atualizar etiqueta

`PATCH /v1/tags/tag_id_1`

```bash
curl -X PATCH "https://rest-api.tbit.app/v1/tags/tag_id_1" \
  -H "X-API-Key: $TBIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Premium",
    "color": "#8b5cf6"
  }'
```

## Excluir etiqueta

`DELETE /v1/tags/tag_id_1`

```bash
curl -X DELETE "https://rest-api.tbit.app/v1/tags/tag_id_1" \
  -H "X-API-Key: $TBIT_API_KEY"
```

## Formato da resposta

Um objeto de etiqueta:

```json
{
  "data": [
    {
      "id": "tag_id_1",
      "name": "VIP",
      "color": "#ef4444",
      "description": "High-priority customers",
      "created_at": "2024-09-01T12:00:00Z",
      "updated_at": "2024-09-01T12:00:00Z"
    },
    {
      "id": "tag_id_2",
      "name": "New Lead",
      "color": "#3b82f6",
      "description": null,
      "created_at": "2024-09-02T08:00:00Z",
      "updated_at": "2024-09-02T08:00:00Z"
    }
  ]
}
```