renameTableColumn

Renames an existing column within a table to better reflect its content or usage. The operation targets a specific table and requires the current and new column names.

PUT /v1/tables/{table}/column

cURL

cURL

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

200

{
  "table": {
    "id": "<string>",
    "name": "<string>",
    "schema": {
      "properties": {},
      "$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"
  }
}

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

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

Show child attributes