Skip to main content
PUT
/
v1
/
admin
/
bots
/
{id}
cURL
curl --request PUT \
  --url https://api.botpress.cloud/v1/admin/bots/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-workspace-id: <x-workspace-id>' \
  --data '{
  "url": "<string>",
  "authentication": "iam",
  "configuration": {
    "data": {},
    "schema": {}
  },
  "tags": {},
  "blocked": true,
  "maxExecutionTime": 123,
  "alwaysAlive": true,
  "user": {
    "tags": {}
  },
  "message": {
    "tags": {}
  },
  "conversation": {
    "tags": {}
  },
  "events": {},
  "actions": {},
  "states": {},
  "recurringEvents": {},
  "integrations": {},
  "plugins": {},
  "subscriptions": {
    "events": {}
  },
  "code": "<string>",
  "name": "<string>",
  "medias": [
    {
      "url": "<string>",
      "name": "<string>"
    }
  ],
  "layers": [
    "<string>"
  ],
  "shouldMergePlugins": true
}'
{
  "bot": {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "signingSecret": "<string>",
    "integrations": {},
    "plugins": {},
    "maxExecutionTime": 123,
    "user": {
      "tags": {}
    },
    "conversation": {
      "tags": {}
    },
    "message": {
      "tags": {}
    },
    "states": {},
    "configuration": {
      "data": {},
      "schema": {}
    },
    "events": {},
    "recurringEvents": {},
    "subscriptions": {
      "events": {}
    },
    "actions": {},
    "tags": {},
    "name": "<string>",
    "deployedAt": "2023-11-07T05:31:56Z",
    "dev": true,
    "createdBy": "<string>",
    "alwaysAlive": true,
    "status": "active",
    "medias": [
      {
        "url": "<string>",
        "name": "<string>"
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

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

Headers

x-workspace-id
string
required

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

id
string
required

Bot ID

Body

application/json

Bot metadata

url
string

URL of the Bot; Only available for dev bots

authentication
enum<string>

Type of the Bot authentication (iam)

Available options:
iam
configuration
object
tags
object

Optional attributes of the Bot

blocked
boolean
maxExecutionTime
integer

Maximum execution time (in seconds).

alwaysAlive
boolean

Indicates if the Bot should be in always alive mode

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

Minimum length: 1
medias
object[]

Media files associated with the Bot

layers
string[]
shouldMergePlugins
boolean

UNUSED. Please ignore this field. It will be removed in the near future.

Response

Success

bot
object
required