Eliminar bot

DELETE

api

typebot

delete

:instance

Eliminar bot

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

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

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

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

Descripción

Elimina bots de la instancia y re-sincroniza la lista restante. Con el query param opcional ?botId=, borra un solo bot; sin botId, borra TODOS los bots de la instancia y desconecta la integración. Cuando ya no queda ningún bot, la integración se desactiva y el vínculo local se borra.

Llamar a este endpoint sin ?botId= elimina todos los bots de la instancia de una sola vez. Úsalo con cuidado.

La re-sincronización de la integración es best-effort: si falla, el servidor solo registra un warning y la eliminación de los bots sigue siendo válida (las filas locales ya fueron borradas). Por eso este endpoint no expone errores de sincronización en la respuesta.

Ejemplo

Eliminar un bot (?botId=)

curl -X DELETE "https://ryzeapi.cloud/api/typebot/delete/suporte?botId=8f3a1c2e-...-b7d9" \
  -H "token: $Token_Account"

await fetch("https://ryzeapi.cloud/api/typebot/delete/suporte?botId=8f3a1c2e-...-b7d9", {
  method: "DELETE",
  headers: {
    "token": process.env.Token_Account
  }
});

import os, requests

requests.delete(
    "https://ryzeapi.cloud/api/typebot/delete/suporte",
    params={"botId": "8f3a1c2e-...-b7d9"},
    headers={
        "token": os.environ["Token_Account"]
    }
)

package main

import (
    "net/http"
    "os"
)

func main() {
    req, _ := http.NewRequest("DELETE", "https://ryzeapi.cloud/api/typebot/delete/suporte?botId=8f3a1c2e-...-b7d9", nil)
    req.Header.Set("token", os.Getenv("Token_Account"))
    http.DefaultClient.Do(req)
}

Eliminar todos los bots

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

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

import os, requests

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

package main

import (
    "net/http"
    "os"
)

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

Respuesta exitosa

200 OK

{
  "success": true,
  "message": "typebot bot(s) deleted",
  "meta": {
    "deleted": 1
  }
}

Campo	Descripción
`success`	`true` cuando la operación tuvo éxito.
`message`	Mensaje fijo de confirmación: `typebot bot(s) deleted`.
`meta.deleted`	Número de bots efectivamente eliminados (`1` con `?botId=`; N sin `botId=`).

Parámetros de ruta

string

requerido

Nombre de la instancia (p. ej., suporte).

Parámetros de consulta

string

UUID del bot a eliminar, obtenido en GET /api/typebot/list/:instance. Ausente, se eliminan TODOS los bots de la instancia.

Cabeceras

string

requerido

TokenAccount o TokenInstance.

Comportamiento

Elimina el/los bot(s) local(es)

Con ?botId=, borra esa fila de typebot_bots (si no existe, devuelve 404). Sin botId=, borra todas las filas de la instancia.

Re-sincroniza los bots restantes (timeout 60 s)

RyzeAPI recalcula la lista de bots y (re)activa la integración. Un fallo aquí solo se registra como warning, no revierte la eliminación.

Desactiva si no queda ninguno

Cuando no queda ningún bot, la integración se desactiva y el vínculo en typebot_integrations se borra.

Errores

HTTP	`error.message`
404	`instance not found`
404	`bot not found for this instance` (solo cuando se pasa un `?botId=` inexistente)

Listar bots

Consulta qué bots siguen registrados en la instancia.

Crear bot

Recrea o agrega un bot con POST /api/typebot/set/:instance.

Introducción

Instancia

Eventos

Mensajes

Llamadas

Grupos

Comunidades

Newsletter

Perfil

Chat

Chatwoot

Typebot

Observabilidad

Descripción

Ejemplo

Respuesta exitosa

Parámetros de ruta

Parámetros de consulta

Cabeceras

Comportamiento

Errores

Siguiente

Listar bots

Crear bot

​Descripción

​Ejemplo

​Respuesta exitosa

​Parámetros de ruta

​Parámetros de consulta

​Cabeceras

​Comportamiento

​Errores

​Siguiente

Listar bots

Crear bot

Descripción

Ejemplo

Respuesta exitosa

Parámetros de ruta

Parámetros de consulta

Cabeceras

Comportamiento

Errores

Siguiente