Skip to main content
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
privacy
/
read-receipts
Read receipts
curl --request POST \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/privacy/read-receipts \
  --header 'Client-Token: <api-key>'

​
Overview

Through this method, you can configure message read receipts (not applicable to groups).
When disabling read receipts, you also won’t be able to see if your own messages were read.

​
Attributes

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

​
Query Parameters

​
value
string
required
Setting value: enable or disable

​
Response

​
200

{
  "success": true
}

​
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”.