Pular para o conteúdo principal
DELETE
/
api
/
chat
/
deleteChat
/
:instance
Apagar chat inteiro
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
}
'

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.

Auth: TokenAccount ou TokenInstanceRate-limit: Global (100/min) • Idempotente: sim Remove um chat (conversa) da sua lista no WhatsApp. Opcionalmente apaga também os arquivos de mídia salvos localmente.
Operação local apenas. Outros participantes (em grupos) ou o destinatário (em DMs) continuam vendo o histórico do lado deles. Para sair de um grupo, use DELETE /api/group/leave.

Exemplos

Manter mídia local

Remove o chat da lista do WhatsApp mas preserva os arquivos de mídia armazenados localmente (S3/disco). Útil quando você ainda quer manter os anexos para auditoria ou reprocessamento.
curl -X DELETE "https://ryzeapi.cloud/api/chat/deleteChat/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{"number": "5511999999999"}'

Apagar mídia também

Com deleteMedia: true, além de remover o chat o servidor também apaga os arquivos de mídia salvos localmente para essa conversa. Operação irreversível do lado da RyzeAPI.
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
  }'

Resposta de sucesso

200 OK
{
  "success": true,
  "message": "Chat deleted successfully (including media)",
  "chat_jid": "5511999999999@s.whatsapp.net",
  "delete_media": true
}
A message muda conforme deleteMedia:
  • false"Chat deleted successfully"
  • true"Chat deleted successfully (including media)"

Path parameters

instance
string
obrigatório
Nome da instância.

Headers

token
string
obrigatório
TokenAccount ou TokenInstance.

Request body

number
string
obrigatório
Número (5511999999999) ou JID (5511999999999@s.whatsapp.net, ...@lid, 120363...@g.us) do chat.
deleteMedia
boolean
padrão:"false"
Se true, também remove os arquivos de mídia armazenados localmente para esse chat.

Notas

  • O chat some da sua lista em todos os dispositivos vinculados (sincroniza via AppState).
  • Em grupos, apagar o chat não sai do grupo, o link com o grupo permanece.
  • O WhatsApp do celular tem storage independente; o deleteMedia aqui afeta apenas as mídias salvas pela RyzeAPI no S3/disco.

Respostas de erro

HTTPerror.messageQuando
400Invalid request bodyJSON malformado.
400Number is requiredCampo ausente.
401Invalid token
404Instance not found
503Instance is not connected to WhatsAppSem sessão ativa.