Skip to content

UnarchiveChat Test#

The method unarchives a chat.


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


For apiUrl, 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": ""


Response parameters#

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

UnarchiveChat 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

Request examples#

import requests

url = "{{apiUrl}}/waInstance{{idInstance}}/unarchiveChat/{{apiTokenInstance}}"

payload = "{\r\n    \"chatId\": \"\"r\n}"
headers = {
  'Content-Type': 'application/json'

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

curl --location '{{apiUrl}}/waInstance{{idInstance}}/unarchiveChat/{{apiTokenInstance}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "chatId": ""
var restTemplate = new RestTemplate();
var requestUrl = new StringBuilder();

var headers = new HttpHeaders();

var jsonBody = "{\"chatId\": \"\"}";

var requestEntity = new HttpEntity<>(jsonBody, headers);

var response =, HttpMethod.POST, requestEntity, String.class);
var requestUrl = new StringBuilder();

var response =
    .header("Content-Type", "application/json")
    .body("{\"chatId\": \"\"}")

Sub UnarchiveChat()
    Dim url As String
    Dim RequestBody As String
    Dim http As Object
    Dim response As String

    ' The apiUrl, idInstance and apiTokenInstance values are available in console, double brackets must be removed
    url = "{{apiUrl}}/waInstance{{idInstance}}/UnarchiveChat/{{apiTokenInstance}}"

    ' ChatId — number for unarchiving the chat ( for private chats, for group chats)
    RequestBody = "{""chatId"":""""}"

    Set http = CreateObject("MSXML2.XMLHTTP")

    With http
        .Open "POST", url, False
        .setRequestHeader "Content-Type", "application/json"
        .Send RequestBody
    End With

    response = http.responseText

    Debug.Print response

    ' Outputting the answer to the desired cell
    Range("A1").Value = response

    Set http = Nothing
End Sub