Deletar Instância

DELETE

api

instance

delete

:instance

Deletar Instância

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: sim

Operação irreversível. Faz logout no WhatsApp, remove a sessão whatsmeow e apaga todos os registros do banco (configurações, webhook, websocket, chatwoot, settings, S3 e a própria instância). Faça backup do que precisar antes.

Não aceita TokenInstance, uma instância não pode pedir para se remover. Use o TokenAccount da conta dona.

Exemplo

Faz DELETE no path da instância usando o TokenAccount. A operação é irreversível: encerra a sessão whatsmeow, faz logout no WhatsApp e remove todos os registros da base (settings, webhook, websocket, chatwoot, proxy, S3 e a própria instância).

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

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

import os, requests

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

package main

import (
    "net/http"
    "os"
)

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

Resposta de sucesso

200 OK

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

Path parameters

string

obrigatório

Nome da instância a deletar.

Headers

string

obrigatório

Seu TokenAccount (apenas o dono da instância pode deletá-la).

O que acontece ao deletar

Se a instância estava conectada, a RyzeAPI faz logout no WhatsApp (o dispositivo some da lista de vinculados no celular).
Webhooks, WebSocket, integração Chatwoot e settings são removidos.
Todos os registros da instância são apagados da base.
Se você tinha S3 configurado, os arquivos já enviados para o bucket não são apagados, gerencie o bucket separadamente.

Erros

HTTP	`error.message`	Quando
401	`Invalid token`	Token ausente, inválido ou TokenInstance (não aceito).
404	`Instance not found`	Nome não existe.
429	`Rate limit exceeded. Try again later.`	Mais de 100 req/min.
500	`Failed to delete instance: <reason>`	Falha interna durante o teardown.

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

Notas

Após deletar, criar uma nova instância com o mesmo nome pode eventualmente conflitar com a limpeza assíncrona do whatsmeow. Se acontecer, aguarde alguns segundos e tente novamente.

Criar nova instância

Provisiona uma nova no lugar, opcionalmente já com webhook, websocket e chatwoot inline.

Logout sem deletar

Se você só quer desconectar do WhatsApp mantendo a instância.

Introdução

Instância

Eventos

Mensagens

Chamadas

Grupos

Comunidades

Newsletter

Perfil

Chat

Chatwoot

Typebot

Observabilidade

Deletar Instância

Exemplo

Resposta de sucesso

Path parameters

Headers

O que acontece ao deletar

Erros

Notas

Próximo

Criar nova instância

Logout sem deletar

​Exemplo

​Resposta de sucesso

​Path parameters

​Headers

​O que acontece ao deletar

​Erros

​Notas

​Próximo

Criar nova instância

Logout sem deletar

Exemplo

Resposta de sucesso

Path parameters

Headers

O que acontece ao deletar

Erros

Notas

Próximo