Skip to main content

Read chats

Method#

/modify-chat#

POST https://api.z-api.io/instances/YOUR_INSTANCE/token/YOUR_TOKEN/modify-chat

Header#

KeyValue
Client-TokenACCOUNT SECURITY TOKEN

Concept#

This method is responsible for performing the action of reading an entire chat or marking a chat as unread.

Attributes#

Required#

AttributeTypeDescription
phoneintegerPhone number you want to change in YOUR chat
actionstringAttribute to mark the chat (read or unread)

Request Body#

Example

{
"phone": "5544999999999",
"action": "read" or "unread"
}

Response#

200#

AttributesTypeDescription
valuebooleanAction confirmation attribute

Example

{
"value": true
}

405#

In this case certify that you are sending the correct specification of the method. This means, verify if you sent a POST or GET as specified at the beginning of this topic.

415#

In case you receive 415 error, make sure to add the “Content-Type” of the object you are sending in the request headers, mostly “application/json”


Code#