Chats

Archive or unarchive a chat

Archives or unarchives a chat for the connected account via a WhatsApp app-state patch. Because WUTS does not persist messages, no last-message key is sent, so WhatsApp may auto-unarchive the chat when a new inbound message arrives; an optional last_message_timestamp can be supplied as a hint.

POST
/chats/{jid}/archive

Archives or unarchives a chat for the connected account via a WhatsApp app-state patch. Because WUTS does not persist messages, no last-message key is sent, so WhatsApp may auto-unarchive the chat when a new inbound message arrives; an optional last_message_timestamp can be supplied as a hint.

Authorization

bearerAuth
AuthorizationBearer <token>

Per-user API token (UUID v4) sent as Authorization: Bearer <token>. Identifies the tenant and user.

In: header

Path Parameters

jid*string

Target chat JID (user or group).

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Payload for archiving or unarchiving a chat.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/chats/5511999999999@s.whatsapp.net/archive" \  -H "Content-Type: application/json" \  -d '{    "archived": true  }'
{  "success": true,  "chat_jid": "5511999999999@s.whatsapp.net",  "archived": true}
{  "success": false,  "error": "validation failed",  "error_code": "VALIDATION_ERROR",  "timestamp": "2026-06-15T12:00:00Z"}
{  "success": false,  "error": "validation failed",  "error_code": "VALIDATION_ERROR",  "timestamp": "2026-06-15T12:00:00Z"}
{  "success": false,  "error": "validation failed",  "error_code": "VALIDATION_ERROR",  "timestamp": "2026-06-15T12:00:00Z"}
{  "success": false,  "error": "validation failed",  "error_code": "VALIDATION_ERROR",  "timestamp": "2026-06-15T12:00:00Z"}