Mark chat as read

POST

api

chat

markChatRead

:instance

Mark chat as read

curl --request POST \
  --url https://api.example.com/api/chat/markChatRead/:instance \
  --header 'Content-Type: application/json' \
  --data '
{
  "number": "<string>",
  "read": true
}
'

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

fetch('https://api.example.com/api/chat/markChatRead/: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/markChatRead/:instance"

payload = {
    "number": "<string>",
    "read": True
}
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

Marks all unread messages of a chat as read (read: true) or undoes the marking (read: false). It is equivalent to opening the chat on the phone: the new-messages badge resets.

To mark a single message (without resetting the badge), use markRead.

Examples

Mark as read

With read: true, marks all unread messages of the chat as read and resets the badge, equivalent to opening the conversation on the phone.

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

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

import os, requests

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

package main

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

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

Mark as unread

With read: false, restores the “unread” state on the chat so it appears highlighted in the list again, useful to revisit a conversation later.

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

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

import os, requests

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

package main

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

func main() {
    body := strings.NewReader(`{
        "number": "5511999999999",
        "read":   false
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/chat/markChatRead/"+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 confirms the operation with chat_jid (JID resolved from number) and read reflecting the final state. The message changes depending on the value of read: "Chat marked as read successfully" or "Chat marked as unread successfully".

200 OK

{
  "success": true,
  "message": "Chat marked as read successfully",
  "chat_jid": "5511999999999@s.whatsapp.net",
  "read": true
}

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

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

boolean

required

true marks as read, false marks as unread.

Error responses

HTTP	`error.message`	When it happens
400	`Instance name is required`	,
400	`Invalid request body: <...>`	Malformed JSON.
400	`Number is required`	,
401	`Invalid token`	,
404	`Instance not found`	,
503	`Instance is not connected to WhatsApp`	,

Error 400

{
  "success": false,
  "error": { "message": "Number is required" }
}

Mark message as read

Mark a single message.

Archive chat

After resetting the badge, archive.

Introduction

Instance

Events

Messages

Calls

Groups

Communities

Newsletter

Profile

Chat

Chatwoot

Typebot

Observability

Mark chat as read

Description

Examples

Mark as read

Mark as unread

Success response

Path parameters

Headers

Request body

Error responses

Mark message as read

Archive chat

​Description

​Examples

​Mark as read

​Mark as unread

​Success response

​Path parameters

​Headers

​Request body

​Error responses

​Related

Mark message as read

Archive chat

Description

Examples

Mark as read

Mark as unread

Success response

Path parameters

Headers

Request body

Error responses

Related