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: <api-key>' \
  --data '{
  "name": "<string>",
  "frozen": true,
  "schema": {},
  "tags": {},
  "isComputeEnabled": true
}'
{
  "table": {
    "id": "<string>",
    "name": "<string>",
    "factor": 1,
    "frozen": true,
    "schema": {
      "$schema": "<string>",
      "properties": {},
      "additionalProperties": true,
      "required": [
        "<string>"
      ],
      "type": "object"
    },
    "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.

​
x-bot-id
string
header
required

Your bot ID.

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 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.

​
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 whether the table is enabled for computation.

Response

200
application/json

The updated table

​
table
object
required
​
staleColumns
string[]

List of columns that have become stale following the modification.