# Criar, editar ou remover etiqueta

`POST /label/edit`

Pasta: **Etiquetas**

## Autenticação

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

## Descrição

# Criar, editar ou remover etiqueta

Cria ou atualiza uma etiqueta no banco e sincroniza com o WhatsApp via App State. Para remover no WhatsApp, envie o `labelid` com `name` vazio.

## Endpoint

`POST {{baseUrl}}/label/edit`

## Autenticação

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

## Corpo da requisição

| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| `labelid` | string | Sim | ID da etiqueta no WhatsApp. |
| `name` | string | Condicional | Nome da etiqueta. Vazio = remover no WhatsApp. |
| `color` | integer | Não | Índice de cor do WhatsApp. |
| `colorHex` | string | Não | Hex opcional; se vazio, a API deriva de `color` + plataforma. |
| `id` | string | Não | ID interno; se omitido, a API reutiliza o existente ou gera um novo. |
| `owner` | string | Não | Dono; se vazio, usa o owner da instância. |

## Exemplo de Requisição

```bash
curl --request POST '{{baseUrl}}/label/edit' \
  --header 'token: {{token}}' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "labelid": "10",
  "name": "Cliente VIP",
  "color": 2
}'
```

## Resposta de Sucesso

```json
{
  "success": true,
  "label": {
    "id": "lbl_abc123",
    "client_name": "gozap",
    "created": "2026-07-17T12:00:00Z",
    "updated": "2026-07-17T12:00:00Z",
    "name": "Cliente VIP",
    "color": 2,
    "colorHex": "#25D366",
    "labelid": "10",
    "owner": "5511999999999"
  }
}
```

## Erros comuns

- `400 Bad Request`: `labelid is required` ou JSON inválido.
- `500 Internal Server Error`: falha ao salvar ou sincronizar com o WhatsApp.
- `401 Unauthorized`: token inválido.

## Observações

- Não há campo `delete` booleano: remoção = `name` vazio.
- Depois de criar/editar, confira a lista em `GET /labels`.

## Corpo (exemplo)

```json
{
  "labelid": "10",
  "name": "Cliente VIP",
  "color": 2
}
```

## cURL

```bash
curl -X POST "{{baseUrl}}/label/edit" \
  -H "token: {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "labelid": "10",
  "name": "Cliente VIP",
  "color": 2
}'
```

---

[Índice da pasta](./index.md) · [Índice geral](../index.md) · [UI](https://gozap.dev/docs?op=etiquetas/criar-editar-ou-remover-etiqueta)