PUT
/
data
/
projects
/
{projectId}
/
bitable
/
{tableName}
/
columns
/
{columnName}
curl --request PUT \
  --url https://partner.peaka.studio/api/v1/data/projects/{projectId}/bitable/{tableName}/columns/{columnName} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "dataType": "<string>",
  "displayName": "<string>",
  "defaultValue": "<string>",
  "isNotNull": true,
  "isUnique": true
}'
[
  {
    "id": "<string>",
    "name": "<string>",
    "dataType": "<string>",
    "displayName": "<string>",
    "defaultValue": "<string>",
    "isNotNull": true,
    "isUnique": true
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
projectId
string
required
​
tableName
string
required
​
columnName
string
required

Body

application/json

This class represents a ColumnRequest. 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
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.

Response

200 - */*
OK
​
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.