Pular para o conteúdo principal
POST
/
api
/
chat
/
favorite
/
:instance
Favoritar chat ou mensagem
curl --request POST \
  --url https://api.example.com/api/chat/favorite/:instance \
  --header 'Content-Type: application/json' \
  --data '
{
  "number": "<string>",
  "messageId": "<string>",
  "favorite": true
}
'
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.
Quando ambos são informados, messageId tem prioridade, o favorito será registrado na mensagem.

​
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. 
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
  }'

​
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. 
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
  }'

​
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). 
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
  }'

​
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.
200 OK
{
  "success": true,
  "message": "Message favoritada successfully",
  "chat_jid": "5511999999999@s.whatsapp.net",
  "message_id": "3EB08FCF27E532F1B0F5",
  "favorite": true,
  "type": "message"
}

​
Parâmetros de rota

​
instance
string
obrigatório
Nome da instância.

​
Headers

NomeObrigatórioExemploDescrição
Content-Typesimapplication/json,
tokensim (ou Authorization)a1b2c3d4-...TokenAccount ou TokenInstance.

​
Request body

​
number
string
Telefone ou JID. Use para favoritar o chat inteiro.
​
messageId
string
ID da mensagem. Use para favoritar uma mensagem específica. Tem prioridade sobre number.
​
favorite
boolean
obrigatório
true favorita, false remove o favorito.
É obrigatório enviar pelo menos um entre number e messageId.

​
Respostas de erro

HTTPerror.messageQuando ocorre
400Instance name is required,
400Invalid request body: <...>JSON malformado.
400Either number or messageId is requiredNenhum dos dois informado.
401Invalid token,
404Instance not found,
404Message not foundmessageId inexistente.
503Instance is not connected to WhatsApp,
Erro 400
{
  "success": false,
  "error": { "message": "Either number or messageId is required" }
}

​
Relacionados

Fixar chat

POST /api/chat/pinChat/:instance

Buscar mensagem

Recuperar uma mensagem favoritada.