Archive chats

Methods

/modify-chat

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

Header

Key	Value
Client-Token	ACCOUNT SECURITY TOKEN

---

Concept

This method is responsible for archiving or unarchiving chats

---

Attributes

Required

Attributes	Type	Descriptions
phone	integer	Phone number you want to change in YOUR chat
action	string	Attribute to archive or unarchive chats

---

Request Body

Example

{

"phone": "5544999999999",

"action": "archive" ou "unarchive"

}

---

Response

200

Attributes	Type	Description
value	boolean	Action 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