Editar bot

PATCH

api

typebot

update

:instance

Editar 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 o TokenInstance • Rate limit: Global (100/min) • Idempotente: sí

Descripción

Edita un bot de Typebot existente de la instancia. La edición es parcial: solo los campos que envías cambian; los que omites mantienen su valor actual. Identifica el bot con botId (obtenido en GET /api/typebot/list/:instance). Con cada cambio, RyzeAPI activa la integración de la instancia.

Para crear un bot nuevo usa POST /api/typebot/set/:instance. Este endpoint solo edita bots ya existentes.

Prioridad de trigger, cuando varias reglas pueden coincidir con el mismo mensaje, gana la más específica:

equals > startsWith / endsWith > contains > regex > all

Unicidad, cada instancia puede tener solo un bot all habilitado; los bots keyword son únicos por combinación de (triggerOperator, triggerValue). Un cambio que provoque un conflicto devuelve 400.

Ejemplo

Editando solo dos campos (enabled y expireMinutes); el resto del bot se mantiene igual:

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

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:       false,
    expireMinutes: 60
  })
});

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":       False,
        "expireMinutes": 60
    }
)

package main

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

func main() {
    body := strings.NewReader(`{
        "botId":         "8f3a1c2e-...-b7d9",
        "enabled":       false,
        "expireMinutes": 60
    }`)
    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)
}

Envía solo el botId + los campos que quieres cambiar. Para cambiar un bot de keyword a all (o viceversa), envía triggerType junto con los campos de trigger correspondientes.

Respuesta exitosa

200 OK

{
  "success": true,
  "message": "typebot bot updated",
  "bot": {
    "id": "8f3a1c2e-...-b7d9",
    "instance_id": "...",
    "enabled": false,
    "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": 60,
    "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"
  }
}

Campo	Descripción
`success`	`true` cuando la operación tuvo éxito.
`message`	Mensaje fijo de confirmación: `typebot bot updated`.
`bot`	El bot ya actualizado, con todos sus campos. Consulta la lista completa en listar bots.

Parámetros de ruta

string

requerido

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

Cabeceras

string

requerido

TokenAccount o TokenInstance.

string

requerido

application/json

Cuerpo de la solicitud

string

requerido

UUID del bot a editar, obtenido en GET /api/typebot/list/:instance.

string

URL del Typebot publicado (viewer). Debe ser una URL válida. La / final se elimina.

string

Cómo se acciona el bot: all o keyword. Si lo cambias a keyword, envía también triggerOperator + triggerValue.

string

Operador del trigger: contains, equals, startsWith, endsWith, regex. Requerido si triggerType pasa a keyword.

string

Palabra o expresión del trigger. Requerida si triggerType pasa a keyword.

boolean

Si el bot está activo en el enrutamiento.

string

Etiqueta del bot en el panel (p. ej., "Bot de orçamento").

integer

Expira la sesión por inactividad tras N minutos. 0 = nunca expira.

string

Mensaje enviado al usuario cuando la sesión expira.

string

Palabra que, enviada por el usuario, finaliza el bot de inmediato (p. ej., "sair").

string

Despedida enviada cuando el bot se finaliza por la keywordFinish.

integer

Delay del indicador “escribiendo…” antes de cada respuesta, en milisegundos.

boolean

Si es true, el bot se pausa en esa conversación cuando tú (el operador) respondes manualmente.

integer

Agrupa los fragmentos enviados por el cliente durante N segundos antes de procesar.

boolean

Si es true, los mensajes de grupo no accionan el bot.

boolean

predeterminado:"false"

Si es true, el bot no inicia solo cuando tú empezaste la conversación. Cuando envías el primer mensaje y el contacto responde, el bot no se dispara. La ventana de reactivación reutiliza expireMinutes (contada desde tu primer mensaje; 0 = permanente).

boolean

predeterminado:"false"

Si es true, al terminar el flujo la conversación permanece abierta en lugar de cerrarse. El bot permanece en silencio (no reinicia) y la sesión solo se cierra por keywordFinish o manualmente, apareciendo con estado held.

Errores

HTTP	`error.message`	Causa
400	`invalid body: ...`	Body malformado, `botId` ausente, `typebotUrl` inválida o `triggerType` fuera de `all`/`keyword`.
400	`triggerOperator and triggerValue are required when triggerType is 'keyword'`	Se cambió a `triggerType: "keyword"` sin operador/valor.
400	`this instance already has an enabled 'all' trigger bot`	El cambio dejaría dos bots `all` habilitados (unicidad).
400	`another enabled bot already uses this trigger operator+value`	El cambio colisiona con otro bot `keyword` habilitado con el mismo `(operator, value)`.
404	`instance not found`	La instancia no existe en RyzeAPI.
404	`bot not found for this instance`	El `botId` indicado no existe en esta instancia.
500	`update bot: ...` / `activate typebot integration: ...`	Fallo de persistencia local o en la (re)activación de la integración.
503	`integration gateway not configured`	Servicio de integración no disponible en el servidor.

Ejemplo de payload de error

botId inexistente en la instancia:

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

Listar bots

Descubre el botId a editar con GET /api/typebot/list/:instance.

Crear bot

Registra un bot nuevo 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

Cabeceras

Cuerpo de la solicitud

Errores

Ejemplo de payload de error

Siguiente

Listar bots

Crear bot

​Descripción

​Ejemplo

​Respuesta exitosa

​Parámetros de ruta

​Cabeceras

​Cuerpo de la solicitud

​Errores

​Ejemplo de payload de error

​Siguiente

Listar bots

Crear bot

Descripción

Ejemplo

Respuesta exitosa

Parámetros de ruta

Cabeceras

Cuerpo de la solicitud

Errores

Ejemplo de payload de error

Siguiente