Skip to main content
POST
Deletes chat

Authorizations

token
string
header
required

Body

application/json
number
string
required

Chat number in international format. For groups, use the full group ID.

Example:

"5511999999999"

deleteChatDB
boolean
default:false

If true, removes the chat from the instance history

Example:

true

deleteMessagesDB
boolean
default:false

If true, removes all local messages of the chat

Example:

true

deleteChatWhatsApp
boolean
default:false

If true, deletes the chat on WhatsApp. For groups, this operation is not allowed and the chat will only be cleared.

Example:

true

clearChatWhatsApp
boolean
default:false

If true, clears the chat conversation on WhatsApp (without leaving the chat). Works for groups and individual chats.

Example:

true

Response

Operation performed successfully

response
string

Success message

Example:

"Chat deletion process completed"

actions
string[]

List of actions performed

Example:
errors
string[]

List of errors that occurred, if any

Example: