Skip to main content
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
read-message
Read messages
curl --request POST \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/read-message \
  --header 'Client-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone": "<string>",
  "messageId": "<string>"
}
'

​
Overview

Method used to mark a message in a chat as read.

​
Attributes

​
instanceId
string
required
Your instance ID. Available in the Z-API panel under Instances.
​
token
string
required
Your Z-API instance token.

​
Required

​
phone
string
required
Recipient/sender phone number (or group ID for group messages) in DDI DDD NUMBER format. E.g.: 551199999999. IMPORTANT Send only numbers, without formatting or masks
​
messageId
string
required
Original message ID. For messages sent by you, it’s the code from your response. For messages sent by a contact, you’ll receive this messageId through your receive webhook

​
Request Body

{
  "phone": "5511999998888",
  "messageId": "3999984263738042930CD6ECDE9VDWSA"
}

​
Response

​
204

No content 
{}

​
405

Make sure you are correctly sending the method specification, that is, verify that you sent POST or GET as specified at the beginning of this topic.

​
415

If you receive a 415 error, make sure to add the “Content-Type” header to your request, which in most cases is “application/json”.