Mark message as read

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>"
}
'

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({messageId: '<string>', number: '<string>', sender: '<string>'})
};

fetch('https://api.example.com/api/chat/markRead/:instance', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/api/chat/markRead/:instance"

payload = {
    "messageId": "<string>",
    "number": "<string>",
    "sender": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

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"
  }'

await fetch(`https://ryzeapi.cloud/api/chat/markRead/${process.env.Instance_Name}`, {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    messageId: "3EB08FCF27E532F1B0F5",
    number:    "5511999999999"
  })
});

import os, requests

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

package main

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

func main() {
    body := strings.NewReader(`{
        "messageId": "3EB08FCF27E532F1B0F5",
        "number":    "5511999999999"
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/chat/markRead/"+os.Getenv("Instance_Name"), body)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

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"
  }'

await fetch(`https://ryzeapi.cloud/api/chat/markRead/${process.env.Instance_Name}`, {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    messageId: "3EB08FCF27E532F1B0F5",
    number:    "120363123456789@g.us",
    sender:    "5511999999999@s.whatsapp.net"
  })
});

import os, requests

requests.post(
    f"https://ryzeapi.cloud/api/chat/markRead/{os.environ['Instance_Name']}",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={
        "messageId": "3EB08FCF27E532F1B0F5",
        "number":    "120363123456789@g.us",
        "sender":    "5511999999999@s.whatsapp.net"
    }
)

package main

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

func main() {
    body := strings.NewReader(`{
        "messageId": "3EB08FCF27E532F1B0F5",
        "number":    "120363123456789@g.us",
        "sender":    "5511999999999@s.whatsapp.net"
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/chat/markRead/"+os.Getenv("Instance_Name"), body)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

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

string

required

Instance name.

Headers

Name	Required	Example	Description
`Content-Type`	yes	`application/json`	,
`token`	yes (or `Authorization`)	`a1b2c3d4-...`	TokenAccount or TokenInstance.

Request body

string

required

ID of the message to mark as read.

string

required

Chat JID: phone number, private JID (...@s.whatsapp.net or ...@lid), group (...@g.us), or newsletter.

string

JID of the message author (...@s.whatsapp.net or ...@lid). Required in groups. Optional in DMs.

Error responses

HTTP	`error.message`	When it happens
400	`Instance name is required`	,
400	`Invalid request body: <...>`	Malformed JSON.
400	`messageId is required`	,
400	`Number is required`	,
400	`sender is required for group messages`	Missing `sender` in a group.
401	`Invalid token`	,
404	`Instance not found`	,
503	`Instance 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.

Introduction

Instance

Events

Messages

Calls

Groups

Communities

Newsletter

Profile

Chat

Chatwoot

Typebot

Observability

Mark message as read

Description

Examples

DM

Group (with sender)

Success response

Path parameters

Headers

Request body

Error responses

Mark chat as read

Delivery status

​Description

​Examples

​DM

​Group (with sender)

​Success response

​Path parameters

​Headers

​Request body

​Error responses

​Related

Mark chat as read

Delivery status

Description

Examples

DM

Group (with sender)

Success response

Path parameters

Headers

Request body

Error responses

Related