Skip to content

ArchiveChat#

The method archives a chat. One can archive chats that have at least one incoming message.

Request#

To archive a chat, you have to execute a request at:

POST https://api.green-api.com/waInstance{{idInstance}}/archiveChat/{{apiTokenInstance}}

For idInstance and apiTokenInstance request parameters, refer to Before you start section.

Request parameters#

Parameter Type Mandatory Description
chatId string Yes User or group chat Id

Request body example#

{
    "chatId": "120363043968066561@g.us"
}

Response#

Response parameters#

The response body is empty. If successful, the server response is 200.

ArchiveChat errors#

For a list of errors common to all methods, refer to Common errors section

HTTP code Error identifier Description
400 "ArchiveChatError: cannot archive chat cause last message not found in chat" chatID is false or there is no message in the chat

Python request example#

import requests

url = "https://api.green-api.com/waInstance{{idInstance}}/archiveChat/{{apiTokenInstance}}"

payload = "{\r\n    \"chatId\": \"120363043968066561@g.us\"r\n}"
headers = {
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data = payload)

print(response.text.encode('utf8'))