Skip to main content
POST
Archive or unarchive chat

Authorizations

apikey
string
header
required

Your Pilot Status API key (ps_...). Evolution GO also accepts Authorization: Bearer <key>.

Path Parameters

instance
string
required

The number's display name in the Pilot Status dashboard.

Body

application/json
archive
boolean
required

true to archive, false to unarchive.

Example:

true

chat
string

Chat JID to archive.

Example:

"5511999999999@s.whatsapp.net"

lastMessage
object

Reference to the chat's last message.

Example:
lastMessage.key
object

Message key with id, remoteJid, fromMe.

lastMessage.messageTimestamp
integer

Unix timestamp of the last message.

Response

Success — provider-native response body.

chatId
string
required

RemoteJid of the chat that was archived/unarchived.

archived
boolean
required

Whether the chat archive modification succeeded.