/v1/definitions/{key}/statuses/{statusId}Change a status's colour, group or tab, or archive it
Edits one status of a page's status column (Leads, Deals): label, its colour — tone: success is green, destructive red, warning amber, secondary grey, brand and brandLight the brand colour —, groupLabel (the tab it files under), isTerminal, groupId (a record group — a section — on this page, or null to file it under nothing) and isActive. It is the call to make a status red, or put statuses in a group or under a tab. isActive: false ARCHIVES the status — records already on it keep it and still read back, but a move onto it is refused — which is the reversible alternative to deleting it; true restores it. An absent field is left alone and the answer is 204. Workspace admin.
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
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"
}