Skip to main content
POST
/
Agent
/
Xmpp
/
ClearMessages
Clear Messages
curl --request POST \
  --url https://{host}/Agent/Xmpp/ClearMessages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "count": 123
}

Overview

Clears any offline messages available for the account from the server.

Authentication

Requires a valid JWT bearer token.

Notes

This endpoint uses the request schema notation described in Pattern matching.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

The body is of type object.

Response

200 - application/json

Success

count
integer
required