Skip to main content
PUT
/
v1
/
tables
/
{table}
cURL
curl --request PUT \
  --url https://api.botpress.cloud/v1/tables/{table} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-bot-id: <x-bot-id>' \
  --data '
{
  "name": "<string>",
  "frozen": true,
  "keyColumn": "<string>",
  "schema": {},
  "tags": {},
  "isComputeEnabled": true,
  "factor": 15.5
}
'
{
  "table": {
    "id": "<string>",
    "name": "<string>",
    "schema": {
      "properties": {},
      "additionalProperties": true,
      "type": "object",
      "$schema": "<string>",
      "required": [
        "<string>"
      ]
    },
    "factor": 1,
    "frozen": true,
    "keyColumn": "<string>",
    "tags": {},
    "isComputeEnabled": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "staleColumns": [
    "<string>"
  ]
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
x-bot-id
string
required

Bot id

​
x-integration-id
string

Integration id

​
x-integration-alias
string

Integration alias

​
x-integration-name
string

Integration name

​
x-user-id
string

User Id

​
x-user-role
string

User Role

Path Parameters

​
table
string
required

The table's name or unique identifier for targeting specific table operations.

Body

application/json

The updated schema/name of the table.

​
name
string

Required. This name is used to identify your table.

Minimum string length: 1
​
frozen
boolean

A table designated as "frozen" is immutable in terms of its name and schema structure; modifications to its schema or a renaming operation are not permitted. The only action that can be taken on such a table is deletion. The schema established at the time of creation is locked in as the final structure. To implement any changes, the table must be duplicated with the desired alterations.

​
keyColumn
string | null

Designate a column as the primary unique identifier for this table. When set, a unique index is automatically created on this column, enabling significantly faster upsert operations. All values in this column must be unique across the table. When set to null, the key index is removed.

​
schema
object

Provide an object or a JSON schema to define the columns of the table. A maximum of 20 keys in the object/schema is allowed.

​
tags
object

Optional tags to help organize your tables. These should be passed here as an object representing key/value pairs.

​
isComputeEnabled
boolean

Indicates if the table is enabled for computation.

​
factor
number

The 'factor' multiplies the row's data storage limit by 4KB and its quota count. It can only be increased, not decreased. For instance, a factor of 2 increases storage to 8KB but counts as 2 rows in your quota.

Required range: 1 <= x <= 30

Response

The updated table

​
table
object
required
​
staleColumns
string[]

List of columns that have become stale following the modification.

Last modified on March 18, 2026