updateBot

Update bot

PUT /v1/admin/bots/{id}

cURL

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>",
  "configuration": {
    "data": {},
    "schema": {}
  },
  "tags": {},
  "blocked": true,
  "maxExecutionTime": 123,
  "alwaysAlive": true,
  "user": {
    "tags": {}
  },
  "message": {
    "tags": {}
  },
  "conversation": {
    "tags": {}
  },
  "events": {},
  "actions": {},
  "states": {},
  "recurringEvents": {},
  "integrations": {},
  "plugins": {},
  "code": "<string>",
  "name": "<string>",
  "description": "<string>",
  "medias": [
    {
      "url": "<string>",
      "name": "<string>"
    }
  ],
  "secrets": {},
  "layers": [
    "<string>"
  ],
  "shouldMergePlugins": true
}
'

200

{
  "bot": {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "signingSecret": "<string>",
    "integrations": {},
    "plugins": {},
    "user": {
      "tags": {}
    },
    "conversation": {
      "tags": {}
    },
    "message": {
      "tags": {}
    },
    "states": {},
    "configuration": {
      "data": {},
      "schema": {}
    },
    "events": {},
    "recurringEvents": {},
    "subscriptions": {
      "events": {}
    },
    "actions": {},
    "tags": {},
    "name": "<string>",
    "dev": true,
    "secrets": [
      "<string>"
    ],
    "alwaysAlive": true,
    "medias": [
      {
        "url": "<string>",
        "name": "<string>"
      }
    ],
    "maxExecutionTime": 123,
    "description": "<string>",
    "deployedAt": "2023-11-07T05:31:56Z",
    "createdBy": "<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 | null

URL of the Bot

authentication · enum<string>

Type of the Bot authentication (iam or hmac-sha256)

Available options: iam, hmac-sha256

configuration · object

Show child attributes

tags · object

Optional attributes of the Bot

Show child attributes

blocked · boolean

maxExecutionTime · integer

Maximum execution time (in seconds).

alwaysAlive · boolean

Indicates if the Bot should be in always alive mode

user · object

Show child attributes

message · object

Show child attributes

conversation · object

Show child attributes

events · object

Show child attributes

actions · object

Show child attributes

states · object

Show child attributes

recurringEvents · object

Show child attributes

integrations · object

Show child attributes

plugins · object

A mapping of plugin aliases to their configuration

Show child attributes

subscriptions · object

Show child attributes

code · string

JavaScript code of the bot

name · string

Optional name for the bot, if not provided will be auto-generated

Minimum string length: 1

description · string

Optional description for the bot

Maximum string length: 2000

medias · object[]

Media files associated with the Bot

Show child attributes

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.

Show child attributes

layers · string[]

shouldMergePlugins · boolean

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

Response

200

application/json

Success

bot · object · required

Show child attributes