Pular para o conteúdo principal
POST
/
api
/
chat
/
archive
/
:instance
Arquivar chat
curl --request POST \
  --url https://api.example.com/api/chat/archive/:instance \
  --header 'Content-Type: application/json' \
  --data '
{
  "number": "<string>",
  "archive": 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 TokenInstance • Rate-limit: Global (100/min) • Idempotente: sim

​
Descrição

Arquiva (archive: true) ou desarquiva (archive: false) um chat. A operação é propagada para o WhatsApp via app state, pode levar segundos até refletir nos demais dispositivos vinculados.

​
Exemplos

​
Arquivar

Move o chat para a pasta de arquivados (archive: true), removendo-o da lista principal sem apagar o histórico. Sincroniza com os demais dispositivos vinculados via app state. 
curl -X POST "https://ryzeapi.cloud/api/chat/archive/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "number":  "5511999999999",
    "archive": true
  }'

​
Desarquivar

Tira o chat da pasta de arquivados (archive: false) e o traz de volta para a lista principal. A operação é propagada para todos os dispositivos vinculados. 
curl -X POST "https://ryzeapi.cloud/api/chat/archive/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "number":  "5511999999999",
    "archive": false
  }'

​
Resposta de sucesso

A resposta confirma a operação com chat_jid (JID resolvido a partir do number) e archived refletindo o estado final. A message muda conforme o valor de archive: "Chat archived successfully" ou "Chat unarchived successfully".
200 OK
{
  "success": true,
  "message": "Chat archived successfully",
  "chat_jid": "5511999999999@s.whatsapp.net",
  "archived": true
}

​
Parâmetros de rota

​
instance
string
obrigatório
Nome da instância.

​
Headers

NomeObrigatórioExemploDescrição
Content-Typesimapplication/json—
tokensim (ou Authorization)a1b2c3d4-...TokenAccount ou TokenInstance.

​
Request body

​
number
string
obrigatório
Telefone, JID privado (...@s.whatsapp.net ou ...@lid), JID de grupo (...@g.us) ou newsletter.
​
archive
boolean
obrigatório
true arquiva, false desarquiva.

​
Respostas de erro

HTTPerror.messageQuando ocorre
400Instance name is required—
400Invalid request body: <...>JSON malformado.
400Number is required—
401Invalid token—
404Instance not found—
503Instance is not connected to WhatsApp—
Erro 400
{
  "success": false,
  "error": { "message": "Number is required" }
}

​
Relacionados

Fixar chat

POST /api/chat/pin/:instance

Silenciar chat

POST /api/chat/mute/:instance