Edit bot

PATCH

api

typebot

update

:instance

Edit bot

curl --request PATCH \
  --url https://api.example.com/api/typebot/update/:instance \
  --header 'Content-Type: <content-type>' \
  --header 'token: <token>' \
  --data '
{
  "botId": "<string>",
  "typebotUrl": "<string>",
  "triggerType": "<string>",
  "triggerOperator": "<string>",
  "triggerValue": "<string>",
  "enabled": true,
  "description": "<string>",
  "expireMinutes": 123,
  "expireMessage": "<string>",
  "keywordFinish": "<string>",
  "finishMessage": "<string>",
  "typingDelayMs": 123,
  "stopBotFromMe": true,
  "debounceSeconds": 123,
  "ignoreGroups": true,
  "noStartFromMe": true,
  "keepOpen": true
}
'

const options = {
  method: 'PATCH',
  headers: {token: '<token>', 'Content-Type': '<content-type>'},
  body: JSON.stringify({
    botId: '<string>',
    typebotUrl: '<string>',
    triggerType: '<string>',
    triggerOperator: '<string>',
    triggerValue: '<string>',
    enabled: true,
    description: '<string>',
    expireMinutes: 123,
    expireMessage: '<string>',
    keywordFinish: '<string>',
    finishMessage: '<string>',
    typingDelayMs: 123,
    stopBotFromMe: true,
    debounceSeconds: 123,
    ignoreGroups: true,
    noStartFromMe: true,
    keepOpen: true
  })
};

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

import requests

url = "https://api.example.com/api/typebot/update/:instance"

payload = {
    "botId": "<string>",
    "typebotUrl": "<string>",
    "triggerType": "<string>",
    "triggerOperator": "<string>",
    "triggerValue": "<string>",
    "enabled": True,
    "description": "<string>",
    "expireMinutes": 123,
    "expireMessage": "<string>",
    "keywordFinish": "<string>",
    "finishMessage": "<string>",
    "typingDelayMs": 123,
    "stopBotFromMe": True,
    "debounceSeconds": 123,
    "ignoreGroups": True,
    "noStartFromMe": True,
    "keepOpen": True
}
headers = {
    "token": "<token>",
    "Content-Type": "<content-type>"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

Auth: TokenAccount or TokenInstance • Rate limit: Global (100/min) • Idempotent: no

Description

Updates an existing Typebot bot on the instance. This is a partial update: only the fields you send are changed, every other field keeps its current value. After saving, RyzeAPI activates the instance’s integration.

The bot to edit is identified by botId in the body (required).

Partial semantics, omit a field to leave it untouched. To clear a text field, send it explicitly as an empty string (""). To create a new bot instead, use POST /api/typebot/set/:instance.

Changing enabled, triggerType, triggerOperator or triggerValue is still subject to the uniqueness rules: each instance can have only one enabled all bot, and keyword bots are unique per (triggerOperator, triggerValue). A conflicting change returns 400.

Example

Editing only a couple of fields (enable the bot and change the expiration):

curl -X PATCH "https://ryzeapi.cloud/api/typebot/update/suporte" \
  -H "token: $Token_Account" \
  -H "Content-Type: application/json" \
  -d '{
    "botId":         "8f3a1c2e-...-b7d9",
    "enabled":       true,
    "expireMinutes": 45
  }'

await fetch("https://ryzeapi.cloud/api/typebot/update/suporte", {
  method: "PATCH",
  headers: {
    "token":        process.env.Token_Account,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    botId:         "8f3a1c2e-...-b7d9",
    enabled:       true,
    expireMinutes: 45
  })
});

import os, requests

requests.patch(
    "https://ryzeapi.cloud/api/typebot/update/suporte",
    headers={
        "token":        os.environ["Token_Account"],
        "Content-Type": "application/json"
    },
    json={
        "botId":         "8f3a1c2e-...-b7d9",
        "enabled":       True,
        "expireMinutes": 45
    }
)

package main

import (
    "net/http"
    "os"
    "strings"
)

func main() {
    body := strings.NewReader(`{
        "botId":         "8f3a1c2e-...-b7d9",
        "enabled":       true,
        "expireMinutes": 45
    }`)
    req, _ := http.NewRequest("PATCH", "https://ryzeapi.cloud/api/typebot/update/suporte", body)
    req.Header.Set("token", os.Getenv("Token_Account"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

You only need to send botId plus the fields you want to change. In the example above typebotUrl, triggerType, description and every other field keep their current values.

Success response

200 OK

{
  "success": true,
  "message": "typebot bot updated",
  "bot": {
    "id": "8f3a1c2e-...-b7d9",
    "instance_id": "...",
    "enabled": true,
    "description": "Bot de orçamento",
    "typebot_url": "https://typebot.co/meu-bot-abc123",
    "trigger_type": "keyword",
    "trigger_operator": "contains",
    "trigger_value": "orçamento",
    "expire_minutes": 45,
    "expire_message": "Sessão encerrada por inatividade.",
    "keyword_finish": "sair",
    "finish_message": "Até logo! 👋",
    "typing_delay_ms": 1500,
    "stop_bot_from_me": true,
    "debounce_seconds": 6,
    "ignore_groups": true,
    "no_start_from_me": false,
    "keep_open": false,
    "active_sessions": 2,
    "last_activity_at": "2026-07-27T13:58:40Z",
    "created_at": "2026-07-20T09:12:00Z",
    "updated_at": "2026-07-27T14:05:22Z"
  }
}

Field	Description
`success`	Always `true` on success.
`message`	Fixed confirmation message (`typebot bot updated`).
`bot`	The full bot after the update, with all fields (including the ones you did not change). See the fields in the list of bots.

Path parameters

string

required

Instance name (e.g., suporte).

Headers

string

required

TokenAccount or TokenInstance.

string

required

application/json

Request body

string

required

UUID of the bot to edit, obtained from GET /api/typebot/list/:instance.

string

New URL of the published Typebot (viewer). Must be a valid URL. The trailing / is removed.

string

How the bot is triggered: all or keyword.

string

Trigger operator, required if you set triggerType to keyword. One of: contains, equals, startsWith, endsWith, regex.

string

Trigger word or expression, required if you set triggerType to keyword.

boolean

Whether the bot is active in routing.

string

Bot label in the panel.

integer

Expires the session by inactivity after N minutes. 0 = never expires.

string

Message sent to the user when the session expires.

string

Word that, when sent by the user, ends the bot immediately.

string

Farewell sent when the bot is ended by the keywordFinish.

integer

Delay of the “typing…” indicator before each reply, in milliseconds.

boolean

If true, the bot is paused in that conversation when you (the operator) reply manually.

integer

Groups fragments sent by the customer for N seconds before processing.

boolean

If true, group messages do not trigger the bot.

boolean

default:"false"

If true, the bot does not auto-start when you started the conversation. When you send the first message and the contact replies, the bot does not trigger. The reactivation window reuses expireMinutes (counted from your first message; 0 = permanent).

boolean

default:"false"

If true, when the flow ends the conversation stays open instead of closing. The bot stays silent (it does not restart) and the session only ends via keywordFinish or manually, appearing with status held.

Errors

HTTP	`error.message`	Cause
400	`invalid body: ...`	Malformed body, missing `botId`, invalid `typebotUrl`, or `triggerType` outside `all`/`keyword`.
400	`triggerOperator and triggerValue are required when triggerType is 'keyword'`	Set `triggerType: "keyword"` without operator/value.
400	`this instance already has an enabled 'all' trigger bot`	The change would create a second enabled `all` bot (uniqueness).
400	`another enabled bot already uses this trigger operator+value`	The change collides with an existing enabled `keyword` bot.
404	`instance not found`	Instance does not exist in RyzeAPI.
404	`bot not found for this instance`	The `botId` provided does not exist in this instance.
500	`update bot: ...` / `activate typebot: ...`	Local persistence failure, or failure activating the integration.
503	`integration gateway not configured`	Integration service unavailable on the server.

Error payload example

botId that does not belong to the instance:

{
  "success": false,
  "error": {
    "message": "bot not found for this instance"
  }
}

List bots

Confirm the new values with GET /api/typebot/list/:instance.

Create bot

Add another 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

Headers

Request body

Errors

Error payload example

Next

List bots

Create bot

​Description

​Example

​Success response

​Path parameters

​Headers

​Request body

​Errors

​Error payload example

​Next

List bots

Create bot

Description

Example

Success response

Path parameters

Headers

Request body

Errors

Error payload example

Next