# Restore a deleted status

```http
PATCH https://secure.yoprint.com/v1/api/store/{team_slug}/setting/status/{id}/restore
```

- API version: v1
- Operation ID: `v1_public_status_restore`
- Section: Team settings › [Statuses](https://developer.yoprint.com/reference/statuses.md)
- Web page: https://developer.yoprint.com/reference/statuses/v1-status-restore/
- Authentication: `Authorization: Bearer YOUR_API_KEY`

Brings back a deleted status, with its label, color, type and position. Find deleted statuses in the full list (`trashed: true`). Restoring a status that is not deleted changes nothing. Returns the status.

## Permission

Needs the Manage Settings permission. The team owner always has it.

## Side effects

- Team members who have YoPrint open see the status come back at once.

## Path parameters

- `team_slug` (string, required): Your team slug, shown as Team ID next to your API key in Profile. Example `your-team`.
- `id` (string, required): The deleted status, from the full status list. Its hash id from an earlier answer; there is no unique key for it. Example `0FBSNFKFGHapYd`.

## Request body

This operation takes no request body.

### Example request

```bash
curl -X PATCH 'https://secure.yoprint.com/v1/api/store/your-team/setting/status/0FBSNFKFGHapYd/restore' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'X-Yoprint-Decimal-Format: exact-v1'
```

## Response

`200` Successful response.

Fields:

- `data` (object, required)
  - `color` (string, required)
  - `customer_label` (string, required): What customers see in the customer portal. When none is set: `Pending` for `start`, `In Progress` for `in_progress` and `pre_production`, `Completed` for `end`.
  - `id` (string, required)
  - `label` (string, required)
  - `position` (integer, required): Sort order within the list, lowest first.
  - `role` (string, required): Which list the status belongs to: - `order`: sales orders - `quote`: quotes - `job`: jobs - `purchase_order`: purchase orders - `shipment`: shipments - `customer_message`: message threads - `pipeline`: tasks within a task preset One of: `"order"`, `"quote"`, `"job"`, `"purchase_order"`, `"shipment"`, `"customer_message"`, `"pipeline"`.
  - `trashed` (boolean, required): True for a deleted status. Only the full list includes deleted ones.
  - `type` (string, required): The stage of the status in the workflow: `start` (first status in the list), `pre_production`, `in_progress`, or `end` (final status). One of: `"start"`, `"pre_production"`, `"in_progress"`, `"end"`.
  - `pipeline_id` (string, optional): The task preset, for `pipeline` statuses only. Absent for every other role.
- `status` (integer, required)
- `success` (boolean, required)

Example response:

```json
{
  "data": {
    "color": "#ff9800",
    "customer_label": "In Progress",
    "id": "0FBSNFKFGHapYd",
    "label": "On hold",
    "position": 3,
    "role": "job",
    "trashed": false,
    "type": "in_progress"
  },
  "status": 200,
  "success": true
}
```

## Errors

- `401` The API key is missing or wrong (`unauthenticated`).
- `403` You are not allowed to do this. `api_access_not_in_plan`: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only `{"message": "Insufficient Permission"}`. Other refusals use the error envelope, with `unauthorized` or `user_is_not_authorized`.
  - When: Your role lacks Manage Settings. The body is `{"message": "Insufficient Permission"}`, without the error envelope. Fix: Use the key of a member whose role has Manage Settings, or the owner's.
- `404` Not found. `page_not_found`: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. `code: null`, with a message that starts "No query results for": there is no record with that id.
  - When: No status of your team, deleted or not, has this id. `error.code` is null; `error.message` names the record type. Fix: Use an id from the full list.

## Notes

- A restored `end` status sits next to any ending status you marked meanwhile; check the list afterwards.

## Related

- [Delete a status](https://developer.yoprint.com/reference/statuses/v1-status-destroy.md): `DELETE /v1/api/store/{team_slug}/setting/status/{status_reference}`
- [List every status, including deleted ones](https://developer.yoprint.com/reference/statuses/v1-status-index.md): `GET /v1/api/store/{team_slug}/setting/status`
