Read Receipts
Method#
/privacy/read-receipts#
Header#
| Key | Value |
|---|---|
| Client-Token | ACCOUNT SECURITY TOKEN |
Concept#
Through this method, you can configure read receipts for messages (not applicable to groups).
Attributes#
Required#
| Attributes | Type | Description |
|---|---|---|
| value | string | Enable or disable read receipts (enable, disable) |
String (value) accepted values:
- enable (Enables read receipts)
- disable (Disables read receipts)
Request Params#
URL example#
Method
POST https://api.z-api.io/instances/YOUR_INSTANCE/token/YOUR_TOKEN/privacy/read-receipts?value=enable
Important
When disabling read receipts, you also won't be able to see if your messages have been read.
Response#
200#
| Attributes | Type | Description |
|---|---|---|
| success | boolean | true if successful, false in case of failure |
Example
405#
In this case, ensure that you are sending the method specification correctly, i.e., check if you sent the POST or PUT as specified at the beginning of this topic.
415#
If you receive a 415 error, make sure to add the "Content-Type" of the object you are sending in the request headers, in most cases, it should be "application/json".