PUT
/
v1
/
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

​
id
string
required

Bot ID

Body

application/json

Bot metadata

The body is of type object.

Response

200
application/json

Success

The response is of type object.

PUT
/
v1
/
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

​
id
string
required

Bot ID

Body

application/json

Bot metadata

The body is of type object.

Response

200
application/json

Success

The response is of type object.