---
title: "Add BI Column"
method: POST
path: "/data/projects/{projectId}/bitable/{tableName}/columns"
tags: ["Data -- Internal Tables"]
---

# Add BI Column

`POST /data/projects/{projectId}/bitable/{tableName}/columns`

## Request

- Base URL: `https://partner.peaka.studio/api/v1`
- URL: `https://partner.peaka.studio/api/v1/data/projects/{projectId}/bitable/{tableName}/columns`
- Auth: HTTP bearer

Adds one or more columns to the specified [Peaka BI Table](https://docs.peaka.com/connecting-your-data/peaka-bi-table). Each column definition includes its name, data type, display name, optional default value, and constraints (nullability, uniqueness). Peaka BI Table supports VARCHAR, BIGINT, BOOLEAN, TIMESTAMP, TIME, DATE, UUID, and DECIMAL data types. Note that JSON data type is not supported in Peaka BI Table.

## Path parameters

- `projectId` string, required
- `tableName` string, required

## Request body

- ColumnRequest: 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` 'VARCHAR' | 'BIGINT' | 'BOOLEAN' | 'DECIMAL' | 'TIMESTAMP' | 'TIME' | 'DATE' | 'UUID': 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.

## Response `200`

Column added successfully

---

[API](https://skmtc.dev/peaka/apis/peaka-gateway-api.md) · [All operations](https://skmtc.dev/peaka/apis/peaka-gateway-api/llms.txt) · [OpenAPI document](https://skmtc.dev/peaka/apis/peaka-gateway-api/revisions/e68b033a22d5?raw)