Docs

updateBot

Update bot

PUT/v1/admin/bots/{id}

Authorization

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

Header parameters

x-workspace-idstringrequired
Workspace ID
x-multiple-integrationsstring
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

idstringrequired
Bot ID

Request body

Bot metadata

urlstring | null
URL of the Bot
authenticationenum<string>
Type of the Bot authentication (`iam` or `hmac-sha256`)
Available options:"iam","hmac-sha256"
configurationobject
tagsobject
Optional attributes of the Bot
blockedboolean
maxExecutionTimeinteger
Maximum execution time (in seconds).
alwaysAliveboolean
Indicates if the Bot should be in always alive mode
userobject
messageobject
conversationobject
eventsobject
actionsobject
statesobject
recurringEventsobject
integrationsobject
pluginsobject
A mapping of plugin aliases to their configuration
subscriptionsobject
codestring
JavaScript code of the bot
namestring
Optional name for the bot, if not provided will be auto-generated(min length: 1)
descriptionstring
Optional description for the bot(max length: 2000)
mediasobject[]
Media files associated with the Bot
secretsobject
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.
layersstring[]
shouldMergePluginsboolean
UNUSED. Please ignore this field. It will be removed in the near future.
typeenum<string>
Type of the Bot
Available options:"studio","adk","desk"

Response

Success

botobjectrequired