> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ryzeapi.cloud/llms.txt
> Use this file to discover all available pages before exploring further.

# Atribuir etiqueta

> Aplica uma etiqueta (label) a um chat

**Auth:** `TokenAccount` ou `TokenInstance` • **Rate-limit:** `Global` (100/min) • **Idempotente:** sim

## Descrição

Atribui uma etiqueta existente a um chat. Se a etiqueta já estiver presente no chat, a operação é tratada como sucesso (idempotente). A mudança é propagada ao WhatsApp via app state.

## Exemplo

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST "https://ryzeapi.cloud/api/chat/assignTag/$Instance_Name" \
    -H "token: $Token_Instance" \
    -H "Content-Type: application/json" \
    -d '{
      "number": "5511999999999",
      "tagId":  "2"
    }'
  ```

  ```javascript JavaScript theme={null}
  await fetch(`https://ryzeapi.cloud/api/chat/assignTag/${process.env.Instance_Name}`, {
    method: "POST",
    headers: {
      "token":        process.env.Token_Instance,
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      number: "5511999999999",
      tagId:  "2"
    })
  });
  ```

  ```python Python theme={null}
  import os, requests

  requests.post(
      f"https://ryzeapi.cloud/api/chat/assignTag/{os.environ['Instance_Name']}",
      headers={
          "token":        os.environ["Token_Instance"],
          "Content-Type": "application/json"
      },
      json={
          "number": "5511999999999",
          "tagId":  "2"
      }
  )
  ```

  ```go Go theme={null}
  package main

  import (
      "net/http"
      "os"
      "strings"
  )

  func main() {
      body := strings.NewReader(`{
          "number": "5511999999999",
          "tagId":  "2"
      }`)
      req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/chat/assignTag/"+os.Getenv("Instance_Name"), body)
      req.Header.Set("token", os.Getenv("Token_Instance"))
      req.Header.Set("Content-Type", "application/json")
      http.DefaultClient.Do(req)
  }
  ```
</CodeGroup>

## Resposta de sucesso

A resposta confirma a atribuição ecoando o `tag_id` aplicado. O `chat_jid` não é incluído quando o handler delega apenas para o serviço (campos `omitempty`); confie em `success`/`message` para o resultado da operação.

```json 200 OK theme={null}
{
  "success": true,
  "message": "Tag assigned successfully",
  "tag_id": "2"
}
```

## Parâmetros de rota

<ParamField path="instance" type="string" required>
  Nome da instância.
</ParamField>

## Headers

| Nome           | Obrigatório              | Exemplo            | Descrição                      |
| -------------- | ------------------------ | ------------------ | ------------------------------ |
| `Content-Type` | sim                      | `application/json` | ,                              |
| `token`        | sim (ou `Authorization`) | `a1b2c3d4-...`     | TokenAccount ou TokenInstance. |

## Request body

<ParamField body="number" type="string" required>
  Telefone (`5511999999999`), JID privado (`...@s.whatsapp.net` ou `...@lid`), JID de grupo (`...@g.us`) ou newsletter.
</ParamField>

<ParamField body="tagId" type="string" required>
  ID da etiqueta a atribuir.
</ParamField>

## Respostas de erro

| HTTP | `error.message`                         | Quando ocorre        |
| ---- | --------------------------------------- | -------------------- |
| 400  | `Instance name is required`             | ,                    |
| 400  | `Invalid request body: <...>`           | JSON malformado.     |
| 400  | `Number is required`                    | ,                    |
| 400  | `tagId is required`                     | ,                    |
| 401  | `Invalid token`                         | ,                    |
| 404  | `Instance not found`                    | ,                    |
| 404  | `Tag not found`                         | `tagId` inexistente. |
| 503  | `Instance is not connected to WhatsApp` | ,                    |

```json Erro 404 theme={null}
{
  "success": false,
  "error": { "message": "Tag not found" }
}
```

## Relacionados

<CardGroup cols={2}>
  <Card title="Desatribuir etiqueta" href="/pt/api/chat/tags-unassign">
    Remover a etiqueta do chat.
  </Card>

  <Card title="Contatos por etiqueta" href="/pt/api/chat/contacts-by-label">
    Listar todos os chats com a etiqueta.
  </Card>
</CardGroup>
