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: <api-key>' \
  --data '{
  "url": "<string>",
  "authentication": "iam",
  "configuration": {
    "data": {},
    "schema": {}
  },
  "tags": {},
  "blocked": true,
  "alwaysAlive": true,
  "user": {
    "tags": {}
  },
  "message": {
    "tags": {}
  },
  "conversation": {
    "tags": {}
  },
  "events": {},
  "actions": {},
  "states": {},
  "recurringEvents": {},
  "integrations": {},
  "subscriptions": {
    "events": {}
  },
  "code": "<string>",
  "name": "<string>",
  "medias": [
    {
      "url": "<string>",
      "name": "<string>"
    }
  ]
}'
{
  "bot": {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "signingSecret": "<string>",
    "integrations": {},
    "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.

x-workspace-id
string
header
required

Your workspace ID.

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

Tags of the Bot

blocked
boolean
alwaysAlive
boolean

Indicates whether the Bot should be in always alive mode

user
object
message
object
conversation
object
events
object
actions
object
states
object
recurringEvents
object
integrations
object
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

Response

200
application/json

Success

bot
object
required