Removes a chat locally, optionally deleting media as well
Auth:Documentation Index
Fetch the complete documentation index at: https://docs.ryzeapi.cloud/llms.txt
Use this file to discover all available pages before exploring further.
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.
deleteMedia: true, in addition to removing the chat the server also deletes the media files stored locally for that conversation. Irreversible on the RyzeAPI side.
message changes depending on deleteMedia:
false → "Chat deleted successfully"true → "Chat deleted successfully (including media)"5511999999999) or JID (5511999999999@s.whatsapp.net, ...@lid, 120363...@g.us) of the chat.true, also removes the media files stored locally for this chat.deleteMedia here only affects the media saved by RyzeAPI on S3/disk.| 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. |