Eliminar instancia

DELETE

api

instance

delete

:instance

Eliminar instancia

curl --request DELETE \
  --url https://api.example.com/api/instance/delete/:instance \
  --header 'token: <token>'

const options = {method: 'DELETE', headers: {token: '<token>'}};

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

Auth: TokenAccount • Rate-limit: Global (100/min) • Idempotente: sí

Operación irreversible. Hace logout de WhatsApp, elimina la sesión whatsmeow y borra todos los registros de la base de datos (settings, webhook, websocket, chatwoot, settings, S3 y la propia instancia). Haz backup de lo que necesites antes.

No acepta TokenInstance, una instancia no puede pedir su propia eliminación. Usa el TokenAccount de la cuenta dueña.

Ejemplo

Envía un DELETE al path de la instancia usando el TokenAccount. La operación es irreversible: termina la sesión whatsmeow, hace logout de WhatsApp y elimina todos los registros de la base de datos (settings, webhook, websocket, chatwoot, proxy, S3 y la propia instancia).

curl -X DELETE "https://ryzeapi.cloud/api/instance/delete/my-instance" \
  -H "token: $Token_Account"

await fetch("https://ryzeapi.cloud/api/instance/delete/my-instance", {
  method: "DELETE",
  headers: {
    "token": process.env.Token_Account
  }
});

import os, requests

requests.delete(
    "https://ryzeapi.cloud/api/instance/delete/my-instance",
    headers={
        "token": os.environ["Token_Account"]
    }
)

package main

import (
    "net/http"
    "os"
)

func main() {
    req, _ := http.NewRequest("DELETE", "https://ryzeapi.cloud/api/instance/delete/my-instance", nil)
    req.Header.Set("token", os.Getenv("Token_Account"))
    http.DefaultClient.Do(req)
}

Respuesta exitosa

200 OK

{
  "success": true,
  "message": "Instance deleted",
  "instance": {
    "status": "deleted"
  }
}

Parámetros de ruta

string

requerido

Nombre de la instancia a eliminar.

Cabeceras

string

requerido

Tu TokenAccount (solo el dueño de la instancia puede eliminarla).

Qué ocurre al eliminar

Si la instancia estaba conectada, RyzeAPI realiza un logout de WhatsApp (el dispositivo desaparece de la lista de dispositivos vinculados en el teléfono).
Webhooks, WebSocket, integración Chatwoot y settings se eliminan.
Todos los registros de la instancia se borran de la base de datos.
Si tenías S3 configurado, los archivos ya subidos al bucket no se eliminan, gestiona el bucket por separado.

Errores

HTTP	`error.message`	Cuándo
401	`Invalid token`	Token faltante, inválido o un TokenInstance (no aceptado).
404	`Instance not found`	Nombre no existe.
429	`Rate limit exceeded. Try again later.`	Más de 100 req/min.
500	`Failed to delete instance: <reason>`	Falla interna durante el teardown.

{
  "success": false,
  "error": {
    "message": "Failed to delete instance: <reason>"
  }
}

Notas

Después de la eliminación, crear una nueva instancia con el mismo nombre puede ocasionalmente entrar en conflicto con la limpieza asíncrona de whatsmeow. Si esto ocurre, espera unos segundos e inténtalo de nuevo.

Crear una nueva instancia

Aprovisiona una nueva en su lugar, opcionalmente con webhook, websocket y chatwoot inline.

Logout sin eliminar

Si solo quieres desconectar de WhatsApp manteniendo la instancia.

Introducción

Instancia

Eventos

Mensajes

Llamadas

Grupos

Comunidades

Newsletter

Perfil

Chat

Chatwoot

Typebot

Observabilidad

Eliminar instancia

Ejemplo

Respuesta exitosa

Parámetros de ruta

Cabeceras

Qué ocurre al eliminar

Errores

Notas

Siguiente

Crear una nueva instancia

Logout sin eliminar

​Ejemplo

​Respuesta exitosa

​Parámetros de ruta

​Cabeceras

​Qué ocurre al eliminar

​Errores

​Notas

​Siguiente

Crear una nueva instancia

Logout sin eliminar

Ejemplo

Respuesta exitosa

Parámetros de ruta

Cabeceras

Qué ocurre al eliminar

Errores

Notas

Siguiente