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

import requests

url = "https://api.botpress.cloud/v1/tables/{table}/column"

payload = {
    "name": "<string>",
    "newName": "<string>"
}
headers = {
    "x-bot-id": "<x-bot-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {
    'x-bot-id': '<x-bot-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({name: '<string>', newName: '<string>'})
};

fetch('https://api.botpress.cloud/v1/tables/{table}/column', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.botpress.cloud/v1/tables/{table}/column",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'newName' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "x-bot-id: <x-bot-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.botpress.cloud/v1/tables/{table}/column"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"newName\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("x-bot-id", "<x-bot-id>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.botpress.cloud/v1/tables/{table}/column")
  .header("x-bot-id", "<x-bot-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"newName\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.botpress.cloud/v1/tables/{table}/column")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["x-bot-id"] = '<x-bot-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"newName\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "table": {
    "id": "<string>",
    "name": "<string>",
    "schema": {
      "properties": {},
      "additionalProperties": true,
      "type": "object",
      "$schema": "<string>",
      "required": [
        "<string>"
      ]
    },
    "factor": 1,
    "frozen": true,
    "tags": {},
    "isComputeEnabled": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

{
  "table": {
    "id": "<string>",
    "name": "<string>",
    "schema": {
      "properties": {},
      "additionalProperties": true,
      "type": "object",
      "$schema": "<string>",
      "required": [
        "<string>"
      ]
    },
    "factor": 1,
    "frozen": true,
    "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