Skip to main content
POST
/
data
/
projects
/
{projectId}
/
bitable
/
{tableName}
/
columns
Add BI Column
curl --request POST \
  --url https://partner.peaka.studio/api/v1/data/projects/{projectId}/bitable/{tableName}/columns \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "name": "varcharcol",
    "dataType": "VARCHAR",
    "displayName": "varcharcol",
    "defaultValue": null,
    "isNotNull": false,
    "isUnique": false
  },
  {
    "name": "bigintcol",
    "dataType": "BIGINT",
    "displayName": "bigintcol",
    "defaultValue": null,
    "isNotNull": false,
    "isUnique": false
  },
  {
    "name": "booleancol",
    "dataType": "BOOLEAN",
    "displayName": "booleancol",
    "defaultValue": null,
    "isNotNull": false,
    "isUnique": false
  },
  {
    "name": "timestampcol",
    "dataType": "TIMESTAMP",
    "displayName": "timestampcol",
    "defaultValue": null,
    "isNotNull": false,
    "isUnique": false
  },
  {
    "name": "timecol",
    "dataType": "TIME",
    "displayName": "timecol",
    "defaultValue": null,
    "isNotNull": false,
    "isUnique": false
  },
  {
    "name": "datecol",
    "dataType": "DATE",
    "displayName": "datecol",
    "defaultValue": null,
    "isNotNull": false,
    "isUnique": false
  },
  {
    "name": "uuidcol",
    "dataType": "UUID",
    "displayName": "uuidcol",
    "defaultValue": null,
    "isNotNull": false,
    "isUnique": false
  },
  {
    "name": "decimalcol",
    "dataType": "DECIMAL",
    "displayName": "decimalcol",
    "defaultValue": null,
    "isNotNull": false,
    "isUnique": false
  }
]
'
import requests

url = "https://partner.peaka.studio/api/v1/data/projects/{projectId}/bitable/{tableName}/columns"

payload = [
    {
        "name": "varcharcol",
        "dataType": "VARCHAR",
        "displayName": "varcharcol",
        "defaultValue": None,
        "isNotNull": False,
        "isUnique": False
    },
    {
        "name": "bigintcol",
        "dataType": "BIGINT",
        "displayName": "bigintcol",
        "defaultValue": None,
        "isNotNull": False,
        "isUnique": False
    },
    {
        "name": "booleancol",
        "dataType": "BOOLEAN",
        "displayName": "booleancol",
        "defaultValue": None,
        "isNotNull": False,
        "isUnique": False
    },
    {
        "name": "timestampcol",
        "dataType": "TIMESTAMP",
        "displayName": "timestampcol",
        "defaultValue": None,
        "isNotNull": False,
        "isUnique": False
    },
    {
        "name": "timecol",
        "dataType": "TIME",
        "displayName": "timecol",
        "defaultValue": None,
        "isNotNull": False,
        "isUnique": False
    },
    {
        "name": "datecol",
        "dataType": "DATE",
        "displayName": "datecol",
        "defaultValue": None,
        "isNotNull": False,
        "isUnique": False
    },
    {
        "name": "uuidcol",
        "dataType": "UUID",
        "displayName": "uuidcol",
        "defaultValue": None,
        "isNotNull": False,
        "isUnique": False
    },
    {
        "name": "decimalcol",
        "dataType": "DECIMAL",
        "displayName": "decimalcol",
        "defaultValue": None,
        "isNotNull": False,
        "isUnique": False
    }
]
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify([
    {
      name: 'varcharcol',
      dataType: 'VARCHAR',
      displayName: 'varcharcol',
      defaultValue: null,
      isNotNull: false,
      isUnique: false
    },
    {
      name: 'bigintcol',
      dataType: 'BIGINT',
      displayName: 'bigintcol',
      defaultValue: null,
      isNotNull: false,
      isUnique: false
    },
    {
      name: 'booleancol',
      dataType: 'BOOLEAN',
      displayName: 'booleancol',
      defaultValue: null,
      isNotNull: false,
      isUnique: false
    },
    {
      name: 'timestampcol',
      dataType: 'TIMESTAMP',
      displayName: 'timestampcol',
      defaultValue: null,
      isNotNull: false,
      isUnique: false
    },
    {
      name: 'timecol',
      dataType: 'TIME',
      displayName: 'timecol',
      defaultValue: null,
      isNotNull: false,
      isUnique: false
    },
    {
      name: 'datecol',
      dataType: 'DATE',
      displayName: 'datecol',
      defaultValue: null,
      isNotNull: false,
      isUnique: false
    },
    {
      name: 'uuidcol',
      dataType: 'UUID',
      displayName: 'uuidcol',
      defaultValue: null,
      isNotNull: false,
      isUnique: false
    },
    {
      name: 'decimalcol',
      dataType: 'DECIMAL',
      displayName: 'decimalcol',
      defaultValue: null,
      isNotNull: false,
      isUnique: false
    }
  ])
};

fetch('https://partner.peaka.studio/api/v1/data/projects/{projectId}/bitable/{tableName}/columns', 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://partner.peaka.studio/api/v1/data/projects/{projectId}/bitable/{tableName}/columns",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    [
        'name' => 'varcharcol',
        'dataType' => 'VARCHAR',
        'displayName' => 'varcharcol',
        'defaultValue' => null,
        'isNotNull' => false,
        'isUnique' => false
    ],
    [
        'name' => 'bigintcol',
        'dataType' => 'BIGINT',
        'displayName' => 'bigintcol',
        'defaultValue' => null,
        'isNotNull' => false,
        'isUnique' => false
    ],
    [
        'name' => 'booleancol',
        'dataType' => 'BOOLEAN',
        'displayName' => 'booleancol',
        'defaultValue' => null,
        'isNotNull' => false,
        'isUnique' => false
    ],
    [
        'name' => 'timestampcol',
        'dataType' => 'TIMESTAMP',
        'displayName' => 'timestampcol',
        'defaultValue' => null,
        'isNotNull' => false,
        'isUnique' => false
    ],
    [
        'name' => 'timecol',
        'dataType' => 'TIME',
        'displayName' => 'timecol',
        'defaultValue' => null,
        'isNotNull' => false,
        'isUnique' => false
    ],
    [
        'name' => 'datecol',
        'dataType' => 'DATE',
        'displayName' => 'datecol',
        'defaultValue' => null,
        'isNotNull' => false,
        'isUnique' => false
    ],
    [
        'name' => 'uuidcol',
        'dataType' => 'UUID',
        'displayName' => 'uuidcol',
        'defaultValue' => null,
        'isNotNull' => false,
        'isUnique' => false
    ],
    [
        'name' => 'decimalcol',
        'dataType' => 'DECIMAL',
        'displayName' => 'decimalcol',
        'defaultValue' => null,
        'isNotNull' => false,
        'isUnique' => false
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://partner.peaka.studio/api/v1/data/projects/{projectId}/bitable/{tableName}/columns"

	payload := strings.NewReader("[\n  {\n    \"name\": \"varcharcol\",\n    \"dataType\": \"VARCHAR\",\n    \"displayName\": \"varcharcol\",\n    \"defaultValue\": null,\n    \"isNotNull\": false,\n    \"isUnique\": false\n  },\n  {\n    \"name\": \"bigintcol\",\n    \"dataType\": \"BIGINT\",\n    \"displayName\": \"bigintcol\",\n    \"defaultValue\": null,\n    \"isNotNull\": false,\n    \"isUnique\": false\n  },\n  {\n    \"name\": \"booleancol\",\n    \"dataType\": \"BOOLEAN\",\n    \"displayName\": \"booleancol\",\n    \"defaultValue\": null,\n    \"isNotNull\": false,\n    \"isUnique\": false\n  },\n  {\n    \"name\": \"timestampcol\",\n    \"dataType\": \"TIMESTAMP\",\n    \"displayName\": \"timestampcol\",\n    \"defaultValue\": null,\n    \"isNotNull\": false,\n    \"isUnique\": false\n  },\n  {\n    \"name\": \"timecol\",\n    \"dataType\": \"TIME\",\n    \"displayName\": \"timecol\",\n    \"defaultValue\": null,\n    \"isNotNull\": false,\n    \"isUnique\": false\n  },\n  {\n    \"name\": \"datecol\",\n    \"dataType\": \"DATE\",\n    \"displayName\": \"datecol\",\n    \"defaultValue\": null,\n    \"isNotNull\": false,\n    \"isUnique\": false\n  },\n  {\n    \"name\": \"uuidcol\",\n    \"dataType\": \"UUID\",\n    \"displayName\": \"uuidcol\",\n    \"defaultValue\": null,\n    \"isNotNull\": false,\n    \"isUnique\": false\n  },\n  {\n    \"name\": \"decimalcol\",\n    \"dataType\": \"DECIMAL\",\n    \"displayName\": \"decimalcol\",\n    \"defaultValue\": null,\n    \"isNotNull\": false,\n    \"isUnique\": false\n  }\n]")

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

	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.post("https://partner.peaka.studio/api/v1/data/projects/{projectId}/bitable/{tableName}/columns")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("[\n  {\n    \"name\": \"varcharcol\",\n    \"dataType\": \"VARCHAR\",\n    \"displayName\": \"varcharcol\",\n    \"defaultValue\": null,\n    \"isNotNull\": false,\n    \"isUnique\": false\n  },\n  {\n    \"name\": \"bigintcol\",\n    \"dataType\": \"BIGINT\",\n    \"displayName\": \"bigintcol\",\n    \"defaultValue\": null,\n    \"isNotNull\": false,\n    \"isUnique\": false\n  },\n  {\n    \"name\": \"booleancol\",\n    \"dataType\": \"BOOLEAN\",\n    \"displayName\": \"booleancol\",\n    \"defaultValue\": null,\n    \"isNotNull\": false,\n    \"isUnique\": false\n  },\n  {\n    \"name\": \"timestampcol\",\n    \"dataType\": \"TIMESTAMP\",\n    \"displayName\": \"timestampcol\",\n    \"defaultValue\": null,\n    \"isNotNull\": false,\n    \"isUnique\": false\n  },\n  {\n    \"name\": \"timecol\",\n    \"dataType\": \"TIME\",\n    \"displayName\": \"timecol\",\n    \"defaultValue\": null,\n    \"isNotNull\": false,\n    \"isUnique\": false\n  },\n  {\n    \"name\": \"datecol\",\n    \"dataType\": \"DATE\",\n    \"displayName\": \"datecol\",\n    \"defaultValue\": null,\n    \"isNotNull\": false,\n    \"isUnique\": false\n  },\n  {\n    \"name\": \"uuidcol\",\n    \"dataType\": \"UUID\",\n    \"displayName\": \"uuidcol\",\n    \"defaultValue\": null,\n    \"isNotNull\": false,\n    \"isUnique\": false\n  },\n  {\n    \"name\": \"decimalcol\",\n    \"dataType\": \"DECIMAL\",\n    \"displayName\": \"decimalcol\",\n    \"defaultValue\": null,\n    \"isNotNull\": false,\n    \"isUnique\": false\n  }\n]")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://partner.peaka.studio/api/v1/data/projects/{projectId}/bitable/{tableName}/columns")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "[\n  {\n    \"name\": \"varcharcol\",\n    \"dataType\": \"VARCHAR\",\n    \"displayName\": \"varcharcol\",\n    \"defaultValue\": null,\n    \"isNotNull\": false,\n    \"isUnique\": false\n  },\n  {\n    \"name\": \"bigintcol\",\n    \"dataType\": \"BIGINT\",\n    \"displayName\": \"bigintcol\",\n    \"defaultValue\": null,\n    \"isNotNull\": false,\n    \"isUnique\": false\n  },\n  {\n    \"name\": \"booleancol\",\n    \"dataType\": \"BOOLEAN\",\n    \"displayName\": \"booleancol\",\n    \"defaultValue\": null,\n    \"isNotNull\": false,\n    \"isUnique\": false\n  },\n  {\n    \"name\": \"timestampcol\",\n    \"dataType\": \"TIMESTAMP\",\n    \"displayName\": \"timestampcol\",\n    \"defaultValue\": null,\n    \"isNotNull\": false,\n    \"isUnique\": false\n  },\n  {\n    \"name\": \"timecol\",\n    \"dataType\": \"TIME\",\n    \"displayName\": \"timecol\",\n    \"defaultValue\": null,\n    \"isNotNull\": false,\n    \"isUnique\": false\n  },\n  {\n    \"name\": \"datecol\",\n    \"dataType\": \"DATE\",\n    \"displayName\": \"datecol\",\n    \"defaultValue\": null,\n    \"isNotNull\": false,\n    \"isUnique\": false\n  },\n  {\n    \"name\": \"uuidcol\",\n    \"dataType\": \"UUID\",\n    \"displayName\": \"uuidcol\",\n    \"defaultValue\": null,\n    \"isNotNull\": false,\n    \"isUnique\": false\n  },\n  {\n    \"name\": \"decimalcol\",\n    \"dataType\": \"DECIMAL\",\n    \"displayName\": \"decimalcol\",\n    \"defaultValue\": null,\n    \"isNotNull\": false,\n    \"isUnique\": false\n  }\n]"

response = http.request(request)
puts response.read_body
[
  {
    "name": "num19",
    "dataType": "bigint",
    "displayName": "num19",
    "defaultValue": null,
    "isNotNull": false,
    "isUnique": false
  },
  {
    "name": "num18",
    "dataType": "bigint",
    "displayName": "num18",
    "defaultValue": "3",
    "isNotNull": false,
    "isUnique": true
  }
]

Authorizations

​
Authorization
string
header
required

Use the Authorization header with the value 'Bearer ' to authenticate. Partner API Keys have full access; Project API Keys are limited to their project scope. Learn more: https://docs.peaka.com/api-reference/authentication

Path Parameters

​
projectId
string
required

ID of the Project

​
tableName
string
required

Name of the BI table

Body

application/json

Column Request

ColumnRequest is used to create, update, display a column in a table. It contains the name, data type, display name, default value, not null and unique status of the column request.

​
name
string

The name of the column.

​
dataType
enum<string>

The data type of the column.

Available options:
VARCHAR,
BIGINT,
BOOLEAN,
DECIMAL,
TIMESTAMP,
TIME,
DATE,
UUID
​
displayName
string

The display name of the column.

​
defaultValue
string

The default value of the column.

​
isNotNull
boolean

The not null flag for the column.

​
isUnique
boolean

The unique flag for the column.

Response

200 - */*

Column added successfully

​
id
string

The id of the column.

​
name
string

The name of the column.

​
dataType
string

The data type of the column.

​
displayName
string

The display name of the column.

​
defaultValue
string

The default value of the column.

​
isNotNull
boolean

The not null flag for the column.

​
isUnique
boolean

The unique flag for the column.

​
desc
string

The description of the column.