Skip to content

Add Workbench Column

POST
/workbench/tables/{table_id}/columns

Add a column.

name is the machine name rows are keyed by and is constrained to ^[a-z][a-z0-9_]*$; display_name is free text. Getting those the wrong way round produces a column nothing can address.

Authorizations

Parameters

Path Parameters

table_id
required

Table id (UUID).

string

Table id (UUID).

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

object
column_type
string
default: data
Allowed values: data formula raw_json
data_type
string
default: text
Allowed values: text number boolean json
display_name
required
string
>= 1 characters <= 255 characters
field_path
Any of:
string
formula
Any of:
string
name
required

Machine name: lowercase, starting with a letter. This is the key row data is addressed by, which is why it is constrained while display_name is not.

string
>= 1 characters <= 255 characters /^[a-z][a-z0-9_]*$/
source
string
default: manual
source_column_id
Any of:
integer

Responses

201

Successful Response

object
data
required
object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string