# Definir etiquetas de um chat

`POST /chat/labels`

Pasta: **Etiquetas**

## Autenticação

```http
token: {{token}}
```

## Descrição

# Definir etiquetas de um chat

Define o conjunto completo de etiquetas (`labels`) de um chat. A API compara com as atuais, adiciona as novas e remove as que saíram da lista.

## Endpoint

`POST {{baseUrl}}/chat/labels`

## Autenticação

Envie o token da instância no header `token: {{token}}`.

## Corpo da requisição

| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| `number` | string | Condicional | Telefone do chat. Informe `number`, `chatid` ou `id`. |
| `chatid` | string | Condicional | JID do chat. |
| `id` | string | Condicional | ID interno do chat. |
| `labels` | array[string] | Sim | IDs das etiquetas desejadas (substitui o conjunto atual). Array vazio remove todas. |

## Exemplo de Requisição

```bash
curl --request POST '{{baseUrl}}/chat/labels' \
  --header 'token: {{token}}' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "number": "5511999999999",
  "labels": ["10", "20", "30"]
}'
```

## Resposta de Sucesso

```json
{
  "success": true
}
```

## Erros comuns

- `400 Bad Request`: `number or chatid is required` (nenhum identificador enviado).
- `500 Internal Server Error`: label inválida, chat inexistente ou instância desconectada.
- `401 Unauthorized`: token inválido.

## Observações

- Obtenha os IDs em `GET /labels`.
- Não existem campos `labelids`, `add_labelid` ou `remove_labelid` nesta API — use sempre `labels`.

## Corpo (exemplo)

```json
{
  "number": "5511999999999",
  "labels": ["10", "20", "30"]
}
```

## cURL

```bash
curl -X POST "{{baseUrl}}/chat/labels" \
  -H "token: {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "number": "5511999999999",
  "labels": ["10", "20", "30"]
}'
```

---

[Índice da pasta](./index.md) · [Índice geral](../index.md) · [UI](https://gozap.dev/docs?op=etiquetas/definir-etiquetas-de-um-chat)