Saltar al contenido principal
POST
/
api
/
chat
/
archive
/
:instance
Archivar 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 o TokenInstance • Rate-limit: Global (100/min) • Idempotente: sí

​
Descripción

Archiva (archive: true) o desarchiva (archive: false) un chat. La operación se propaga a WhatsApp vía app state, puede tardar segundos en reflejarse en los demás dispositivos vinculados.

​
Ejemplos

​
Archivar

Mueve el chat a la carpeta de archivados (archive: true), quitándolo de la lista principal sin borrar el historial. Sincroniza con los demás dispositivos vinculados vía 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
  }'

​
Desarchivar

Saca el chat de la carpeta de archivados (archive: false) y lo regresa a la lista principal. La operación se propaga a todos los 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
  }'

​
Respuesta exitosa

La respuesta confirma la operación con chat_jid (JID resuelto desde number) y archived reflejando el estado final. El message cambia según el valor de archive: "Chat archived successfully" o "Chat unarchived successfully".
200 OK
{
  "success": true,
  "message": "Chat archived successfully",
  "chat_jid": "5511999999999@s.whatsapp.net",
  "archived": true
}

​
Parámetros de ruta

​
instance
string
requerido
Nombre de la instancia.

​
Cabeceras

NombreRequeridoEjemploDescripción
Content-Typesíapplication/json—
tokensí (o Authorization)a1b2c3d4-...TokenAccount o TokenInstance.

​
Cuerpo de la solicitud

​
number
string
requerido
Número de teléfono, JID privado (...@s.whatsapp.net o ...@lid), JID de grupo (...@g.us) o newsletter.
​
archive
boolean
requerido
true archiva, false desarchiva.

​
Respuestas de error

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

​
Relacionados

Fijar chat

POST /api/chat/pin/:instance

Silenciar chat

POST /api/chat/mute/:instance