Skip to main content
POST
/
api
/
chat
/
markRead
/
:instance
Mark message as read
curl --request POST \
  --url https://api.example.com/api/chat/markRead/:instance \
  --header 'Content-Type: application/json' \
  --data '
{
  "messageId": "<string>",
  "number": "<string>",
  "sender": "<string>"
}
'

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 or TokenInstance • Rate-limit: Global (100/min) • Idempotent: yes

​
Description

Sends the read ACK for a specific message, the visible effect for the sender is the “blue check”. To mark the entire chat at once, use markChatRead.
In groups, the sender field (JID of the message author) is required. In 1-to-1 conversations it is optional and may be omitted.

​
Examples

​
DM

In a 1-to-1 conversation, just messageId and the contact’s number are needed. sender can be skipped, the server infers the author from the chat JID. 
curl -X POST "https://ryzeapi.cloud/api/chat/markRead/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "messageId": "3EB08FCF27E532F1B0F5",
    "number":    "5511999999999"
  }'

​
Group (with sender)

In a group (@g.us), the sender field with the message author’s JID is required, without it WhatsApp cannot route the read ACK correctly. 
curl -X POST "https://ryzeapi.cloud/api/chat/markRead/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "messageId": "3EB08FCF27E532F1B0F5",
    "number":    "120363123456789@g.us",
    "sender":    "5511999999999@s.whatsapp.net"
  }'

​
Success response

The response echoes the message_id that was marked and the resolved chat_jid. Useful to audit which messages were marked as read, especially in automated flows that confirm receipt after processing the message.
200 OK
{
  "success": true,
  "message": "Message marked as read successfully",
  "message_id": "3EB08FCF27E532F1B0F5",
  "chat_jid": "5511999999999@s.whatsapp.net"
}

​
Path parameters

​
instance
string
required
Instance name.

​
Headers

NameRequiredExampleDescription
Content-Typeyesapplication/json—
tokenyes (or Authorization)a1b2c3d4-...TokenAccount or TokenInstance.

​
Request body

​
messageId
string
required
ID of the message to mark as read.
​
number
string
required
Chat JID: phone number, private JID (...@s.whatsapp.net or ...@lid), group (...@g.us), or newsletter.
​
sender
string
JID of the message author (...@s.whatsapp.net or ...@lid). Required in groups. Optional in DMs.

​
Error responses

HTTPerror.messageWhen it happens
400Instance name is required—
400Invalid request body: <...>Malformed JSON.
400messageId is required—
400Number is required—
400sender is required for group messagesMissing sender in a group.
401Invalid token—
404Instance not found—
503Instance is not connected to WhatsApp—
Error 400
{
  "success": false,
  "error": { "message": "sender is required for group messages" }
}

Mark chat as read

Mark the entire chat at once.

Delivery status

Check the current status of the message.