Delete entire chat

DELETE

api

chat

deleteChat

:instance

Delete entire chat

curl --request DELETE \
  --url https://api.example.com/api/chat/deleteChat/:instance \
  --header 'Content-Type: application/json' \
  --header 'token: <token>' \
  --data '
{
  "number": "<string>",
  "deleteMedia": true
}
'

const options = {
  method: 'DELETE',
  headers: {token: '<token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({number: '<string>', deleteMedia: true})
};

fetch('https://api.example.com/api/chat/deleteChat/:instance', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/api/chat/deleteChat/:instance"

payload = {
    "number": "<string>",
    "deleteMedia": True
}
headers = {
    "token": "<token>",
    "Content-Type": "application/json"
}

response = requests.delete(url, json=payload, headers=headers)

print(response.text)

Auth: 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.

Local operation only. Other participants (in groups) or the recipient (in DMs) keep seeing the history on their side. To leave a group, use DELETE /api/group/leave.

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.

curl -X DELETE "https://ryzeapi.cloud/api/chat/deleteChat/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{"number": "5511999999999"}'

await fetch(`https://ryzeapi.cloud/api/chat/deleteChat/${process.env.Instance_Name}`, {
  method: "DELETE",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({ number: "5511999999999" })
});

import os, requests

requests.delete(
    f"https://ryzeapi.cloud/api/chat/deleteChat/{os.environ['Instance_Name']}",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={"number": "5511999999999"}
)

package main

import (
    "net/http"
    "os"
    "strings"
)

func main() {
    body := strings.NewReader(`{"number": "5511999999999"}`)
    req, _ := http.NewRequest("DELETE", "https://ryzeapi.cloud/api/chat/deleteChat/"+os.Getenv("Instance_Name"), body)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

Delete media too

With 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.

curl -X DELETE "https://ryzeapi.cloud/api/chat/deleteChat/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "number": "5511999999999",
    "deleteMedia": true
  }'

await fetch(`https://ryzeapi.cloud/api/chat/deleteChat/${process.env.Instance_Name}`, {
  method: "DELETE",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    number:      "5511999999999",
    deleteMedia: true
  })
});

import os, requests

requests.delete(
    f"https://ryzeapi.cloud/api/chat/deleteChat/{os.environ['Instance_Name']}",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={
        "number":      "5511999999999",
        "deleteMedia": True
    }
)

package main

import (
    "net/http"
    "os"
    "strings"
)

func main() {
    body := strings.NewReader(`{
        "number": "5511999999999",
        "deleteMedia": true
    }`)
    req, _ := http.NewRequest("DELETE", "https://ryzeapi.cloud/api/chat/deleteChat/"+os.Getenv("Instance_Name"), body)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

Success response

200 OK

{
  "success": true,
  "message": "Chat deleted successfully (including media)",
  "chat_jid": "5511999999999@s.whatsapp.net",
  "delete_media": true
}

The message changes depending on deleteMedia:

false → "Chat deleted successfully"
true → "Chat deleted successfully (including media)"

Path parameters

string

required

Instance name.

Headers

string

required

TokenAccount or TokenInstance.

Request body

string

required

Number (5511999999999) or JID (5511999999999@s.whatsapp.net, ...@lid, 120363...@g.us) of the chat.

boolean

default:"false"

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; deleteMedia here 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.

Introduction

Instance

Events

Messages

Calls

Groups

Communities

Newsletter

Profile

Chat

Chatwoot

Typebot

Observability

Delete entire chat

Examples

Keep media local

Delete media too

Success response

Path parameters

Headers

Request body

Notes

Error responses

​Examples

​Keep media local

​Delete media too

​Success response

​Path parameters

​Headers

​Request body

​Notes

​Error responses

Examples

Keep media local

Delete media too

Success response

Path parameters

Headers

Request body

Notes

Error responses