Skip to main content
POST
Create Link Column with Auto Join Condition

Authorizations

Authorization
string
header
required

This API uses OAuth 2.0 with the authorization code grant flow.

Path Parameters

workspaceId
string<uuid>
required

Workspace identifier

tableId
string<uuid>
required

Source (parent) table identifier

Body

application/json
uiDataType
enum<string>
required
Available options:
LINK
colOptions
object
required
uiMetadata
object
required
formula
string
required

Raw SQL-style formula matching the whereClause, used for backend processing

name
string
required

Internal column name — must be unique within the table

Response

200 - application/json

Link column with auto join condition created successfully

id
string<uuid>

Unique identifier of the created link column

name
string

Internal column name, unique within the table

uiDataType
string

Always returns LINK for link columns

formula
string

Raw SQL-style formula used for the join condition

backendDataType
string

Underlying database data type assigned to the column

workspaceId
string<uuid>

Workspace this column belongs to

colOptions
object
uiMetadata
object
tableId
string<uuid>

Table ID where this column resides