Delete Instance

DELETE

api

instance

delete

:instance

Delete Instance

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) • Idempotent: yes

Irreversible operation. It logs out from WhatsApp, removes the whatsmeow session and wipes every record from the database (settings, webhook, websocket, chatwoot, settings, S3 and the instance itself). Back up anything you need beforehand.

Does not accept TokenInstance, an instance cannot ask for its own removal. Use the TokenAccount of the owner account.

Example

Sends a DELETE to the instance path using the TokenAccount. The operation is irreversible: it terminates the whatsmeow session, logs out from WhatsApp and removes every record from the database (settings, webhook, websocket, chatwoot, proxy, S3 and the instance itself).

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)
}

Success response

200 OK

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

Path parameters

string

required

Name of the instance to delete.

Headers

string

required

Your TokenAccount (only the instance owner can delete it).

What happens on delete

If the instance was connected, RyzeAPI performs a WhatsApp logout (the device disappears from the linked-devices list on the phone).
Webhooks, WebSocket, Chatwoot integration and settings are removed.
All instance records are wiped from the database.
If you had S3 configured, files already uploaded to the bucket are not deleted, manage the bucket separately.

Errors

HTTP	`error.message`	When
401	`Invalid token`	Token missing, invalid or a TokenInstance (not accepted).
404	`Instance not found`	Name does not exist.
429	`Rate limit exceeded. Try again later.`	More than 100 req/min.
500	`Failed to delete instance: <reason>`	Internal failure during teardown.

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

Notes

After deletion, creating a new instance with the same name may occasionally conflict with the asynchronous whatsmeow cleanup. If that happens, wait a few seconds and try again.

Create a new instance

Provisions a new one in its place, optionally with inline webhook, websocket and chatwoot.

Logout without deleting

If you only want to disconnect from WhatsApp while keeping the instance.

Introduction

Instance

Events

Messages

Calls

Groups

Communities

Newsletter

Profile

Chat

Chatwoot

Typebot

Observability

Delete Instance

Example

Success response

Path parameters

Headers

What happens on delete

Errors

Notes

Next

Create a new instance

Logout without deleting

​Example

​Success response

​Path parameters

​Headers

​What happens on delete

​Errors

​Notes

​Next

Create a new instance

Logout without deleting

Example

Success response

Path parameters

Headers

What happens on delete

Errors

Notes

Next