Archive Chat

Archive or unarchive a WhatsApp chat.

POST /chat/archiveChat/:instanceName

cURL (Simple)

curl --request POST \
  --url https://api.example.com/chat/archiveChat/my-instance \
  --header 'apikey: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "archive": true,
    "chat": "[e-mail]"
  }'

curl --request POST \
  --url https://api.example.com/chat/archiveChat/my-instance \
  --header 'apikey: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "archive": true,
    "lastMessage": {
      "key": {
        "id": "3EB0123456789ABCDEF",
        "fromMe": false,
        "remoteJid": "[e-mail]"
      },
      "messageTimestamp": 1709553600
    }
  }'

const response = await fetch(
  'https://api.example.com/chat/archiveChat/my-instance',
  {
    method: 'POST',
    headers: {
      'apikey': 'YOUR_API_KEY',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      archive: true,
      chat: '[e-mail]'
    })
  }
);

const data = await response.json();

import requests

response = requests.post(
    'https://api.example.com/chat/archiveChat/my-instance',
    headers={
        'apikey': 'YOUR_API_KEY',
        'Content-Type': 'application/json'
    },
    json={
        'archive': True,
        'chat': '[e-mail]'
    }
)

data = response.json()

201 Success

{
  "archived": true,
  "chat": "[e-mail]"
}

{
  "error": "Invalid request",
  "message": "Either 'chat' or 'lastMessage' must be provided"
}

{
  "error": "Unauthorized",
  "message": "Invalid API key"
}

{
  "error": "Chat not found",
  "message": "The specified chat does not exist"
}

Overview

You can archive or unarchive chats in your WhatsApp instance. Archiving a chat removes it from your main chat list but preserves all messages and history.

Archiving a chat doesn’t delete any messages. You can unarchive it at any time to restore it to your main chat list.

Authentication

This endpoint requires authentication via the apikey header.

header.apikey · string · required

Your Evolution API key for authentication.

Path Parameters

path.instanceName · string · required

The name of your WhatsApp instance.

Request Body

archive · boolean · required

Set to true to archive the chat, or false to unarchive it.

chat · string

The remote JID of the chat to archive. Required if lastMessage is not provided.

lastMessage · object

Information about the last message in the chat. Can be used instead of chat parameter.

Show properties

lastMessage.key · object · required

Message key object.

Show properties

lastMessage.key.id · string · required

Message ID.

lastMessage.key.fromMe · boolean · required

Whether the message was sent by you.

lastMessage.key.remoteJid · string · required

Remote JID of the chat.

lastMessage.messageTimestamp · number

Unix timestamp of the message.

Response

archived · boolean

Confirmation of the archive status.

chat · string

The remote JID of the archived/unarchived chat.

cURL (Simple)

curl --request POST \
  --url https://api.example.com/chat/archiveChat/my-instance \
  --header 'apikey: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "archive": true,
    "chat": "[e-mail]"
  }'

curl --request POST \
  --url https://api.example.com/chat/archiveChat/my-instance \
  --header 'apikey: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "archive": true,
    "lastMessage": {
      "key": {
        "id": "3EB0123456789ABCDEF",
        "fromMe": false,
        "remoteJid": "[e-mail]"
      },
      "messageTimestamp": 1709553600
    }
  }'

const response = await fetch(
  'https://api.example.com/chat/archiveChat/my-instance',
  {
    method: 'POST',
    headers: {
      'apikey': 'YOUR_API_KEY',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      archive: true,
      chat: '[e-mail]'
    })
  }
);

const data = await response.json();

import requests

response = requests.post(
    'https://api.example.com/chat/archiveChat/my-instance',
    headers={
        'apikey': 'YOUR_API_KEY',
        'Content-Type': 'application/json'
    },
    json={
        'archive': True,
        'chat': '[e-mail]'
    }
)

data = response.json()

201 Success

{
  "archived": true,
  "chat": "[e-mail]"
}

{
  "error": "Invalid request",
  "message": "Either 'chat' or 'lastMessage' must be provided"
}

{
  "error": "Unauthorized",
  "message": "Invalid API key"
}

{
  "error": "Chat not found",
  "message": "The specified chat does not exist"
}

Usage Notes

To unarchive a chat, send the same request with archive: false.

When archiving a chat, new messages will still be received, and the chat may be automatically unarchived if a new message arrives (depending on WhatsApp settings).