/v1/definitions/{key}/columnsAdd a column to a page
Adds a column to a record page. kind is one of text, number, date, select, checkbox, url, email, phone, person, tags, currency, percent, rating, relation, datetime, long_text, address, file, formula, lookup, and config is validated against that kind — a select's options, a relation's target (config.definitionKey: any page OR any custom board, whose key is the board's definitionKey, board-…), a formula or lookup's references, which are checked against columns that actually exist. source defaults to own and otherwise must read crm:<object>.<field> or app:<object>.<field>; priority defaults to 50 (0-1000); minWidth is 40-800, or 0 (the default) to let the app size the column by its kind and header. The new column goes last in the page's order. Workspace admin. A record's Notes tab draws the column labelled Notes; a page without one gets it here (label Notes, kind long_text).
Access class: def:admin.
Send request
Use the documented inputs to call this endpoint directly.
Parameters
Values are applied to the request and the example on the right.
Request body
application/jsonrequiredResponses
the action's answer
{
"data": {
"alignEnd": true,
"calculation": "string",
"config": {},
"defaultEnabled": true,
"id": "",
"kind": "string",
"label": "string",
"minWidth": 1.5,
"options": [
{
"groupLabel": "string",
"id": "",
"label": "string",
"position": "string",
"tone": "string",
"value": "string"
}
],
"position": 1.5,
"priority": 1.5,
"source": "string",
"starred": true
}
}a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.
{
"error": "string"
}