Flush cached history sync messages

curl --request POST \
  --url https://wsapi.chat/session/flush-history \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Instance-Id: <x-instance-id>'

{
  "status": "ok"
}

Session

Flush cached history sync messages

Returns 202 Accepted immediately, then asynchronously publishes cached history sync messages as message_history_sync events (one per chat, chunked at 500 messages). The consumer should call this endpoint after receiving the initial_sync_finished event, which is only emitted when historySync is enabled and fires after the RECENT history sync completes and all messages have been cached. Requires the instance to have historySync enabled and the device to be paired. Cached messages expire after 1 hour.

POST

session

flush-history

curl --request POST \
  --url https://wsapi.chat/session/flush-history \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Instance-Id: <x-instance-id>'

{
  "status": "ok"
}

Authorizations

X-Api-Key

string

header

required

Instance or customer-level API key. Either the instance's own API key or the customer's API key is accepted. Must be paired with the X-Instance-Id header to identify the target instance.

Headers

X-Instance-Id

string

default:{{instanceId}}

required

The ID of the WhatsApp instance to use

Response

History flush initiated

status

string

Example:

"ok"

Logout from WhatsApp

Send a text message

⌘I

Overview

Endpoints

Flush cached history sync messages

Authorizations

Headers

Response