Chat
Delete entire chat
Removes a chat locally, optionally deleting media as well
DELETE
Delete entire chat
Auth:
The
TokenAccount or TokenInstance • Rate-limit: Global (100/min) • Idempotent: yes
Removes a chat (conversation) from your WhatsApp list. Optionally also deletes the locally stored media files.
Examples
Keep media local
Removes the chat from the WhatsApp list but preserves the media files stored locally (S3/disk). Useful when you still want to keep attachments for auditing or reprocessing.Delete media too
WithdeleteMedia: true, in addition to removing the chat the server also deletes the media files stored locally for that conversation. Irreversible on the RyzeAPI side.
Success response
200 OK
message changes depending on deleteMedia:
false→"Chat deleted successfully"true→"Chat deleted successfully (including media)"
Path parameters
Instance name.
Headers
TokenAccount or TokenInstance.
Request body
Number (
5511999999999) or JID (5511999999999@s.whatsapp.net, ...@lid, 120363...@g.us) of the chat.If
true, also removes the media files stored locally for this chat.Notes
- The chat disappears from your list on every linked device (synced via AppState).
- In groups, deleting the chat does not leave the group, the group link remains.
- The phone’s WhatsApp has independent storage;
deleteMediahere only affects the media saved by RyzeAPI on S3/disk.
Error responses
| HTTP | error.message | When |
|---|---|---|
| 400 | Invalid request body | Malformed JSON. |
| 400 | Number is required | Missing field. |
| 401 | Invalid token | , |
| 404 | Instance not found | , |
| 503 | Instance is not connected to WhatsApp | No active session. |