Skip to main content
POST
/
chats
/
{chatId}
/
clear
Clear all messages from a chat
curl --request POST \
  --url https://api.wsapi.chat/chats/{chatId}/clear \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Instance-Id: <x-instance-id>'
{
  "status": 400,
  "detail": "invalid request body"
}

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

Path Parameters

​
chatId
string
required

Chat JID (user or group)

Response

Chat cleared