Saltar al contenido principal
DELETE
/
api
/
instance
/
logout
/
:instance
Desloguear instancia
curl --request DELETE \
  --url https://api.example.com/api/instance/logout/:instance \
  --header 'token: <token>'

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 TokenInstanceRate-limit: Global (100/min) • Idempotente:

Descripción

Desvincula el dispositivo de WhatsApp (equivalente a hacer clic en “Cerrar sesión” en WhatsApp Web) y cierra el websocket. El registro de la instancia no se elimina, el token sigue siendo válido para un futuro connect (con un nuevo QR).

Ejemplo

Envía un DELETE al path de logout para desvincular el dispositivo de WhatsApp y cerrar el WebSocket. El registro de la instancia se preserva, por lo que el mismo token puede reutilizarse en una futura llamada a connect.
curl -X DELETE "https://ryzeapi.cloud/api/instance/logout/my-instance" \
  -H "token: $Token_Instance"

Respuesta exitosa

200 OK
{
  "success": true,
  "message": "Instance logged out",
  "instance": {
    "status": "loggedout"
  }
}

Parámetros de ruta

instance
string
requerido
Nombre de la instancia.

Cabeceras

token
string
requerido
TokenAccount o TokenInstance.

Errores

HTTPerror.messageCuándo
401Invalid tokenToken faltante o inválido.
404Instance not foundNombre no existe.
429Rate limit exceeded. Try again later.Más de 100 req/min.
500Failed to logout instanceFalla interna.
{
  "success": false,
  "error": {
    "message": "Instance not found"
  }
}

Notas

Después del logout, reconnect ya no funciona, la sesión whatsmeow se elimina. Usa connect para generar un nuevo QR.
Esto no elimina el registro de la instancia. Para eliminarlo completamente (incluyendo settings, webhooks y datos), usa DELETE /api/instance/delete/:instance.

Siguiente

Conectar de nuevo

Genera un nuevo QR para vincular otro dispositivo.

Eliminar instancia

Para eliminar todo permanentemente.