> ## 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.

# Favoritar chat ou mensagem

> Marca um chat inteiro ou uma mensagem específica como favorita

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

## Descrição

Marca como favorito **um chat** (informando `number`) **ou** **uma mensagem específica** (informando `messageId`). Pelo menos um dos dois deve estar presente.

<Info>
  Quando ambos são informados, **`messageId` tem prioridade**, o favorito será registrado na mensagem.
</Info>

## Exemplos

### Favoritar chat

Marca a conversa inteira como favorita informando apenas `number`. Usa-se para destacar contatos importantes na lista, sem amarrar o favorito a uma mensagem específica.

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

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

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

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

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

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

  func main() {
      body := strings.NewReader(`{
          "number":   "5511999999999",
          "favorite": true
      }`)
      req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/chat/favorite/"+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>

### Favoritar mensagem

Favorita uma mensagem específica via `messageId`. Quando ambos os campos são enviados, `messageId` tem prioridade e o favorito é registrado na mensagem em vez do chat.

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST "https://ryzeapi.cloud/api/chat/favorite/$Instance_Name" \
    -H "token: $Token_Instance" \
    -H "Content-Type: application/json" \
    -d '{
      "messageId": "3EB08FCF27E532F1B0F5",
      "favorite":  true
    }'
  ```

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

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

  requests.post(
      f"https://ryzeapi.cloud/api/chat/favorite/{os.environ['Instance_Name']}",
      headers={
          "token":        os.environ["Token_Instance"],
          "Content-Type": "application/json"
      },
      json={
          "messageId": "3EB08FCF27E532F1B0F5",
          "favorite":  True
      }
  )
  ```

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

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

  func main() {
      body := strings.NewReader(`{
          "messageId": "3EB08FCF27E532F1B0F5",
          "favorite":  true
      }`)
      req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/chat/favorite/"+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>

### Remover favorito

Com `favorite: false`, desfaz o favorito previamente registrado no chat ou na mensagem (a depender de qual campo foi informado, mesmo padrão de prioridade dos exemplos anteriores).

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST "https://ryzeapi.cloud/api/chat/favorite/$Instance_Name" \
    -H "token: $Token_Instance" \
    -H "Content-Type: application/json" \
    -d '{
      "messageId": "3EB08FCF27E532F1B0F5",
      "favorite":  false
    }'
  ```

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

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

  requests.post(
      f"https://ryzeapi.cloud/api/chat/favorite/{os.environ['Instance_Name']}",
      headers={
          "token":        os.environ["Token_Instance"],
          "Content-Type": "application/json"
      },
      json={
          "messageId": "3EB08FCF27E532F1B0F5",
          "favorite":  False
      }
  )
  ```

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

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

  func main() {
      body := strings.NewReader(`{
          "messageId": "3EB08FCF27E532F1B0F5",
          "favorite":  false
      }`)
      req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/chat/favorite/"+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

O campo `type` indica o que foi marcado: `"chat"` quando você favoritou a conversa inteira, ou `"message"` quando passou um `messageId` (nesse caso `message_id` aparece preenchido). `chat_jid` é sempre devolvido. `favorite` reflete o estado final.

```json 200 OK theme={null}
{
  "success": true,
  "message": "Message favoritada successfully",
  "chat_jid": "5511999999999@s.whatsapp.net",
  "message_id": "3EB08FCF27E532F1B0F5",
  "favorite": true,
  "type": "message"
}
```

## 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">
  Telefone ou JID. Use para favoritar o **chat inteiro**.
</ParamField>

<ParamField body="messageId" type="string">
  ID da mensagem. Use para favoritar uma **mensagem específica**. Tem prioridade sobre `number`.
</ParamField>

<ParamField body="favorite" type="boolean" required>
  `true` favorita, `false` remove o favorito.
</ParamField>

<Note>
  É obrigatório enviar **pelo menos um** entre `number` e `messageId`.
</Note>

## Respostas de erro

| HTTP | `error.message`                          | Quando ocorre              |
| ---- | ---------------------------------------- | -------------------------- |
| 400  | `Instance name is required`              | ,                          |
| 400  | `Invalid request body: <...>`            | JSON malformado.           |
| 400  | `Either number or messageId is required` | Nenhum dos dois informado. |
| 401  | `Invalid token`                          | ,                          |
| 404  | `Instance not found`                     | ,                          |
| 404  | `Message not found`                      | `messageId` inexistente.   |
| 503  | `Instance is not connected to WhatsApp`  | ,                          |

```json Erro 400 theme={null}
{
  "success": false,
  "error": { "message": "Either number or messageId is required" }
}
```

## Relacionados

<CardGroup cols={2}>
  <Card title="Fixar chat" href="/pt/api/chat/pinChat">
    `POST /api/chat/pinChat/:instance`
  </Card>

  <Card title="Buscar mensagem" href="/pt/api/chat/find-message">
    Recuperar uma mensagem favoritada.
  </Card>
</CardGroup>