# 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`.

## Endpoint

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

## Parameters

| Name | In | Type | Required |
| --- | --- | --- | --- |
| key | path | string | Yes |
| statusId | path | string | Yes |

## Request body

Content type: `application/json`.

```json
{
  "body": {
    "groupId": "",
    "groupLabel": "string",
    "isActive": true,
    "isTerminal": true,
    "label": "string",
    "tone": "string"
  },
  "params": {
    ":key": "string",
    ":statusId": ""
  },
  "query": {}
}
```

## Responses

### 200

the action's answer

Content type: `application/json`.

### default

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.

Content type: `application/json`.

```json
{
  "error": "string"
}
```