Remove bot

DELETE

api

typebot

delete

:instance

Remove 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 or TokenInstance • Rate limit: Global (100/min) • Idempotent: yes

Description

Removes Typebot bots from the instance and re-syncs the remaining list. Pass ?botId= to remove a single bot; without botId, all the instance’s bots are removed and the integration is disconnected. When no bot is left, the integration is deactivated and the local link is deleted.

Calling DELETE /api/typebot/delete/:instance without ?botId= removes every bot of the instance and disconnects the integration. Provide ?botId= when you only want to remove one.

The re-sync is best-effort: if it fails, the server only logs a warning and the bot removal remains valid (the local rows were already deleted). That’s why this endpoint does not expose integration errors in its return.

Example

Remove a single bot

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",
    headers={
        "token": os.environ["Token_Account"]
    },
    params={ "botId": "8f3a1c2e-...-b7d9" }
)

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

Remove all bots of the instance

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

Success response

200 OK

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

Field	Description
`success`	Always `true` on success.
`message`	Fixed confirmation message (`typebot bot(s) deleted`).
`meta.deleted`	Number of bots actually removed (`1` with `?botId=`, or the full count when removing all).

Path parameters

string

required

Instance name (e.g., suporte).

Query parameters

string

UUID of a single bot to remove, obtained from GET /api/typebot/list/:instance. Omitted, all the instance’s bots are removed and the integration is disconnected.

Headers

string

required

TokenAccount or TokenInstance.

Behavior

Remove the local bot(s)

Deletes the matching row(s) from the typebot_bots table. With ?botId=, only that bot; without it, all of them.

Re-sync the remaining bots (60s timeout)

RyzeAPI recomputes the list of bots and (re)activates the integration. A failure here is only logged as a warning, it does not revert the removal.

Deactivate if none is left

When no bot remains, the integration is deactivated and the link in typebot_integrations is deleted.

Errors

HTTP	`error.message`
404	`instance not found`
404	`bot not found`

List bots

Check which bots are still registered on the instance.

Create bot

Recreate or add a bot with POST /api/typebot/set/:instance.

Introduction

Instance

Events

Messages

Calls

Groups

Communities

Newsletter

Profile

Chat

Chatwoot

Typebot

Observability

Description

Example

Success response

Path parameters

Query parameters

Headers

Behavior

Errors

Next

List bots

Create bot

​Description

​Example

​Success response

​Path parameters

​Query parameters

​Headers

​Behavior

​Errors

​Next

List bots

Create bot

Description

Example

Success response

Path parameters

Query parameters

Headers

Behavior

Errors

Next