Docs

updateBot

Update bot

PUT/v1/admin/bots/{id}

Authorization

AuthorizationBearer
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Header parameters

x-workspace-idstring
Workspace ID
x-multiple-integrations?string
Whether the client supports bots with multiple instances of the same integration. Set to "true" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.

Path parameters

idstring
Bot ID

Request body

Bot metadata

url?string | null
URL of the Bot
authentication?enum<string>
Type of the Bot authentication (`iam` or `hmac-sha256`)
Available options:"iam","hmac-sha256"
configuration?object
blocked?boolean
maxExecutionTime?integer
Maximum execution time (in seconds).
alwaysAlive?boolean
Indicates if the Bot should be in always alive mode
tags?object
Optional attributes of the Bot. Set to null or empty string to remove.
user?object
message?object
conversation?object
events?object
actions?object
states?object
recurringEvents?object
integrations?object
plugins?object
A mapping of plugin aliases to their configuration
subscriptions?object
code?string
JavaScript code of the bot
name?string
Optional name for the bot, if not provided will be auto-generated(min length: 1)
description?string
Optional description for the bot(max length: 2000)
medias?object[]
Media files associated with the Bot
secrets?object
Secrets are values available in the code via environment variables formatted with a SECRET_ prefix followed by your secret name. A secret name must respect SCREAMING_SNAKE casing.
layers?string[]
type?enum<string>
Available options:"studio","adk"

Response

Success

botobject