Skip to main content
PUT
/
instances
/
{instanceId}
/
token
/
{token}
/
update-auto-read-status
Auto-read status
curl --request PUT \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/update-auto-read-status \
  --header 'Client-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "value": true
}'

​
Overview

This method enables automatic reading of all status posts received by the API.
For this to work, you must have Auto-read messages enabled.

​
Attributes

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

​
Body

​
value
boolean
required
true to enable auto-read status or false to disable

​
Request Body

{
  "value": true
}

​
Response

​
200

{
  "value": true
}

​
405

Make sure you are correctly sending the method specification, that is, verify that you sent 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” header to your request, which in most cases is “application/json”.