renameTableColumn

PUT

tables

{table}

column

curl --request PUT \
  --url https://api.botpress.cloud/v1/tables/{table}/column \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "newName": "<string>"
}'

{
  "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"
  }
}

Path Parameters

table

string

required

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

Body

application/json

Details of the column to be renamed, including its current name and the desired new name.

name

string

required

The existing name of the column.

newName

string

required

The new name to assign to the column.

Required string length: 1 - 30

Response

200

application/json

Confirmation of the column rename operation, including the updated table schema.

table

object

required

table.id

string

required

Unique identifier for the table

table.name

string

required

Required. This name is used to identify your table.

Minimum length: 1

table.schema

object

required

table.factor

number

default:1

The 'factor' multiplies the row's data storage limit by 4KB and its quota count, but can only be set at table creation and not modified later. For instance, a factor of 2 increases storage to 8KB but counts as 2 rows in your quota. The default factor is 1.

Required range: 1 <= x <= 30

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

table.tags

object

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

table.isComputeEnabled

boolean

Indicates if the table is enabled for computation.

table.createdAt

string

Timestamp of table creation.

table.updatedAt

string

Timestamp of the last table update.

Was this page helpful?

Suggest edits Raise issue

duplicateTable getTableRow

curl --request PUT \
  --url https://api.botpress.cloud/v1/tables/{table}/column \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "newName": "<string>"
}'

{
  "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"
  }
}

Chat API

Admin API

Files API

Tables API

Runtime API

renameTableColumn

Path Parameters

Body

Response