/v1/definitions/{key}Change definitions key
Renames a record page or changes its icon, and carries the page's two switches: tagsEnabled, and recordsEnabled, which decides only whether the board draws the sub-record dropdown under a row — the relations themselves are untouched either way. An absent field is left alone, a blank or over-120-character name is refused, and the answer is the page as it now stands. Workspace admin; this changes the page's SHAPE, not any record on it.
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": {
"access": "string",
"columns": [
{
"alignEnd": true,
"calculation": "string",
"config": {
"bands": [
{
"tone": "string",
"upTo": 1.5
}
],
"definitionKey": "string",
"object": "string"
},
"defaultEnabled": true,
"id": "",
"kind": "string",
"label": "string",
"minWidth": 1.5,
"position": 1.5,
"priority": 1.5,
"source": "string",
"starred": true
}
],
"createdAt": "string",
"icon": "string",
"id": "",
"key": "string",
"name": "string",
"object": "string",
"pack": "string",
"position": 1.5,
"recordsEnabled": true,
"statuses": [
{
"groupLabel": "string",
"id": "",
"isActive": true,
"isTerminal": true,
"label": "string",
"position": 1.5,
"tone": "string",
"value": "string"
}
],
"tagsEnabled": true,
"templateKey": "string",
"updatedAt": "string",
"views": [
{
"columnIds": [
"string"
],
"filter": {},
"id": "",
"key": "string",
"label": "string",
"position": 1.5,
"scope": "string",
"sort": {}
}
]
}
}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"
}