PUT

https://{server-url}

/
chat
/
markMessageAsRead
/
{instance}
curl --request PUT \
  --url https://{server-url}/chat/markMessageAsRead/{instance} \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '{
  "read_messages": [
    {
      "remoteJid": "<string>",
      "fromMe": true,
      "id": "<string>"
    }
  ]
}'
{
  "message": "Read messages",
  "read": "success"
}

Authorizations

apikey
string
headerrequired

Your authorization key header

Path Parameters

instance
string
required

ID of the instance to connect

Body

application/json
read_messages
object[]

Messages to be mark as read

Response

201 - application/json
message
string

A brief message describing the action performed.

read
string

The status of the read action.