PATCH/v1/definitions/{key}/statuses/{statusId}

Change definitions key statuses statusId

Edits one status: label, tone, groupLabel, isTerminal, groupId (a record group on this page, or null to file it under nothing) and isActive. 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.

API serverbase URL

Bearer tokensessionoptional

Stored only in this browser for the session security scheme and reused on every API page in this group.

Parameters

Values are applied to the request and the example on the right.

keypath · stringrequired

statusIdpath · stringrequired

Request body

application/jsonrequired

bodyoptional

paramsoptional

queryobjectoptional

Responses

200application/json

the action's answer

defaultapplication/json

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"
}

errorstringrequired