Saltar al contenido principal
POST
/
api
/
chat
/
markChatRead
/
:instance
Marcar chat como leído
curl --request POST \
  --url https://api.example.com/api/chat/markChatRead/:instance \
  --header 'Content-Type: application/json' \
  --data '
{
  "number": "<string>",
  "read": 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 todos los mensajes no leídos de un chat como leídos (read: true) o deshace la marca (read: false). Es equivalente a abrir el chat en el teléfono: el contador de mensajes nuevos se resetea.
Para marcar un único mensaje (sin resetear el contador), usa markRead.

​
Ejemplos

​
Marcar como leído

Con read: true, marca todos los mensajes no leídos del chat como leídos y resetea el contador, equivalente a abrir la conversación en el teléfono. 
curl -X POST "https://ryzeapi.cloud/api/chat/markChatRead/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "number": "5511999999999",
    "read":   true
  }'

​
Marcar como no leído

Con read: false, restaura el estado “no leído” en el chat para que aparezca destacado en la lista nuevamente, útil para revisar una conversación más tarde. 
curl -X POST "https://ryzeapi.cloud/api/chat/markChatRead/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "number": "5511999999999",
    "read":   false
  }'

​
Respuesta exitosa

La respuesta confirma la operación con chat_jid (JID resuelto desde number) y read reflejando el estado final. El message cambia según el valor de read: "Chat marked as read successfully" o "Chat marked as unread successfully".
200 OK
{
  "success": true,
  "message": "Chat marked as read successfully",
  "chat_jid": "5511999999999@s.whatsapp.net",
  "read": true
}

​
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
requerido
Número de teléfono, JID privado (...@s.whatsapp.net o ...@lid), JID de grupo (...@g.us) o newsletter.
​
read
boolean
requerido
true marca como leído, false marca como no leído.

​
Respuestas de error

HTTPerror.messageCuándo ocurre
400Instance name is required—
400Invalid request body: <...>JSON malformado.
400Number is required—
401Invalid token—
404Instance not found—
503Instance is not connected to WhatsApp—
Error 400
{
  "success": false,
  "error": { "message": "Number is required" }
}

​
Relacionados

Marcar mensaje como leído

Marca un solo mensaje.

Archivar chat

Después de resetear el contador, archiva.