/v1/definitions/{key}/statusesAdd a status to a page
Adds a status to a page's vocabulary: value is the stored word and must be snake_case, label is what a person reads (up to 60 characters), tone is one of secondary, brandLight, brand, warning, success, destructive or a lowercase #rrggbb (default secondary), groupLabel files it under a section and isTerminal marks it an end state. The new status goes last in the order; a value the page already carries is a 409. Workspace admin — the vocabulary is shape, while moving a record between statuses is any member's.
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": {
"groupLabel": "string",
"id": "",
"isActive": true,
"isTerminal": true,
"label": "string",
"position": 1.5,
"tone": "string",
"value": "string"
}
}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"
}