updateBot

PUT

admin

bots

{id}

curl --request PUT \
  --url https://api.botpress.cloud/v1/admin/bots/{id} \
  --header 'Content-Type: application/json' \
  --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>"
      }
    ]
  }
}

Path Parameters

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

Response

200

application/json

Success

bot

object

required

bot.id

string

required

Id of the Bot

Required string length: 28 - 36

bot.createdAt

string

required

Creation date of the Bot in ISO 8601 format

bot.updatedAt

string

required

Updating date of the Bot in ISO 8601 format

bot.signingSecret

string

required

Signing secret of the Bot

Maximum length: 2000

bot.integrations

object

required

A mapping of integrations to their configuration

bot.user

object

required

User object configuration

bot.conversation

object

required

Conversation object configuration

bot.message

object

required

Message object configuration

bot.states

object

required

A mapping of states to their definition

bot.configuration

object

required

Configuration of the bot

bot.events

object

required

Events definition

bot.recurringEvents

object

required

Recurring events

bot.subscriptions

object

required

Subscriptions of the bot

bot.actions

object

required

Actions definition

bot.tags

object

required

Tags of Bot

bot.name

string

required

Name of the Bot

bot.dev

boolean

required

Indicates if the Bot is a development bot; Development bots run locally and can install dev integrations

bot.alwaysAlive

boolean

required

Indicates if the Bot should be in always alive mode

bot.status

enum<string>

required

Status of the bot

Available options:

active,

deploying

bot.medias

object[]

required

Media files associated with the Bot

bot.deployedAt

string

Last deployment date of the Bot in the ISO 8601 format

bot.createdBy

string

Id of the user that created the bot

Was this page helpful?

Suggest edits Raise issue

listBots getBot

curl --request PUT \
  --url https://api.botpress.cloud/v1/admin/bots/{id} \
  --header 'Content-Type: application/json' \
  --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>"
      }
    ]
  }
}

Chat API

Admin API

Files API

Tables API

Runtime API

Path Parameters

Body

Response