Conversations

Delete Chat

Deletes an entire chat. It can clear only in the app or also in the database.

POSThttps://api.zapzapapi.com/api/v1/{instanceId}/chat/delete

Authentication with the x-api-key and x-api-secret headers.

Parameters

NameTypeInRequiredDescription
numbertextbodyYesChat number in international format. For groups, use the full group ID.
deleteChatDBselectbodyNoIf true, deletes the chat from the database
deleteMessagesDBselectbodyNoIf true, deletes all chat messages from the database
deleteChatWhatsAppselectbodyNoIf true, deletes the chat from WhatsApp. For groups, this operation is not allowed and the chat will only be cleared.
clearChatWhatsAppselectbodyNoIf true, clears the chat conversation on WhatsApp (without leaving the chat). Works for groups and individual conversations.

Request example

curl

curl -X POST "https://api.zapzapapi.com/api/v1/{instanceId}/chat/delete" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-api-secret: YOUR_API_SECRET" \
  -H "Content-Type: application/json" \
  -d '{"number":"5511999999999"}'

Node.js

const res = await fetch("https://api.zapzapapi.com/api/v1/{instanceId}/chat/delete", {
  method: "POST",
  headers: {
    "x-api-key": "YOUR_API_KEY",
    "x-api-secret": "YOUR_API_SECRET",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "number": "5511999999999"
  }),
});
console.log(await res.json());

Python

import requests

res = requests.post(
    "https://api.zapzapapi.com/api/v1/{instanceId}/chat/delete",
    headers={"x-api-key": "YOUR_API_KEY", "x-api-secret": "YOUR_API_SECRET"},
    json={"number":"5511999999999"},
)
print(res.json())

Response example

JSON

{
  "actions": [],
  "response": "Chat deletion process completed"
}

Values are illustrative; the fields follow the real response format.

See the full reference

Get your API keys

Create your account, connect a number in minutes and start using the API. R$15 per active number/month, with a welcome credit when you create the account, subject to the current campaign.