Saltar al contenido principal
POST
/
api
/
chat
/
favorite
/
:instance
Marcar chat o mensaje como favorito
curl --request POST \
  --url https://api.example.com/api/chat/favorite/:instance \
  --header 'Content-Type: application/json' \
  --data '
{
  "number": "<string>",
  "messageId": "<string>",
  "favorite": true
}
'

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.

Auth: TokenAccount o TokenInstance • Rate-limit: Global (100/min) • Idempotente: sí

​
Descripción

Marca un chat como favorito (pasando number) o un mensaje específico (pasando messageId). Al menos uno de los dos debe estar presente.
Cuando se proporcionan ambos, messageId tiene prioridad, el favorito se registra en el mensaje.

​
Ejemplos

​
Marcar chat como favorito

Marca la conversación entera como favorita pasando solo number. Úsalo para destacar contactos importantes en la lista, sin atar el favorito a un mensaje específico. 
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
  }'

​
Marcar mensaje como favorito

Marca un mensaje específico como favorito vía messageId. Cuando se envían ambos campos, messageId tiene prioridad y el favorito se registra en el mensaje en lugar del 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
  }'

​
Quitar favorito

Con favorite: false, deshace el favorito previamente registrado en el chat o el mensaje (según el campo proporcionado, misma regla de prioridad que en los ejemplos 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
  }'

​
Respuesta exitosa

El campo type indica qué se marcó: "chat" cuando marcaste la conversación entera, o "message" cuando pasaste un messageId (en ese caso message_id viene relleno). chat_jid siempre se devuelve. favorite refleja el estado final.
200 OK
{
  "success": true,
  "message": "Message favorited successfully",
  "chat_jid": "5511999999999@s.whatsapp.net",
  "message_id": "3EB08FCF27E532F1B0F5",
  "favorite": true,
  "type": "message"
}

​
Parámetros de ruta

​
instance
string
requerido
Nombre de la instancia.

​
Cabeceras

NombreRequeridoEjemploDescripción
Content-Typesíapplication/json—
tokensí (o Authorization)a1b2c3d4-...TokenAccount o TokenInstance.

​
Cuerpo de la solicitud

​
number
string
Número de teléfono o JID. Úsalo para marcar el chat completo como favorito.
​
messageId
string
ID del mensaje. Úsalo para marcar un mensaje específico como favorito. Tiene prioridad sobre number.
​
favorite
boolean
requerido
true marca como favorito, false quita el favorito.
Debes enviar al menos uno de number y messageId.

​
Respuestas de error

HTTPerror.messageCuándo ocurre
400Instance name is required—
400Invalid request body: <...>JSON malformado.
400Either number or messageId is requiredNinguno proporcionado.
401Invalid token—
404Instance not found—
404Message not foundEl messageId no existe.
503Instance is not connected to WhatsApp—
Error 400
{
  "success": false,
  "error": { "message": "Either number or messageId is required" }
}

​
Relacionados

Fijar chat

POST /api/chat/pin/:instance

Buscar mensaje

Recupera un mensaje marcado como favorito.