Skip to main content
Archive or unarchive a chat conversation. Archived chats are hidden from the main chat list but can still receive new messages.
Archived chats will automatically unarchive when a new message is received, unless you have enabled the “Keep chats archived” setting in WhatsApp.

​
Request

​
chat_jid
string
required
Chat JID identifier:Example: [email protected]
​
X-Device-Id
string
Device identifier for multi-device support. Required when multiple devices are registered. If only one device is registered, it will be used as the default.
​
archived
boolean
required
Whether to archive (true) or unarchive (false) the chat

​
Response

​
status
integer
HTTP status code (e.g., 200)
​
code
string
Response code (e.g., SUCCESS)
​
message
string
Response message describing the resultExample: Chat archived successfully
​
results
object
​
status
string
Status of the operationExample: success
​
message
string
Detailed status message
​
chat_jid
string
The JID of the affected chat
​
archived
boolean
The new archived status
curl -X POST \
  'https://your-api-domain.com/chat/[email protected]/archive' \
  -H 'Content-Type: application/json' \
  -H 'X-Device-Id: my-device' \
  -u 'username:password' \
  -d '{
    "archived": true
  }'

{
  "status": 200,
  "code": "SUCCESS",
  "message": "Chat archived successfully",
  "results": {
    "status": "success",
    "message": "Chat archived successfully",
    "chat_jid": "[email protected]",
    "archived": true
  }
}

Build docs developers (and LLMs) love

Get started for freeTalk to us