Delete a status

DELETE/v1/api/store/{team_slug}/setting/status/{status_reference}

v1Operation ID v1_public_status_destroy

Deletes an in-between (in_progress) or ending (end) status. Starting (start) and pre_production statuses can't be deleted: the call answers 500 and changes nothing.

The delete is soft. Records already in this status keep it and still show its label; it just leaves the lists you pick from. Nothing checks whether the status is in use first. Bring it back with PATCH /v1/api/store/{team_slug}/setting/status/{id}/restore.

Permission

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

Business rules

• Only in_progress and end statuses can be deleted.
• A status in use can be deleted; the records using it keep it.
• Deleting the end status leaves the list without an ending status until you restore it or mark another one with "Save a set of status changes".

Side effects

• Team members who have YoPrint open see the status disappear at once.

Path parameters

• team_slugstringrequired

  Your team slug, shown as Team ID next to your API key in Profile.

  • Example your-team
• status_referencestringrequired

  The status. Its hash id from an earlier answer; there is no unique key for it.

  • Example 0CoeFF1BmpcxxE

Request body

This operation takes no request body.

Response

200Successful response.

• datanullrequired
• statusintegerrequired
• successbooleanrequired

Errors

• 401The API key is missing or wrong (unauthenticated).

• 403You 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.

• 404Not 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 has this id. error.code is null; error.message names the record type.

  Fix

  Use an id from the status lists.

• 500A business rule refused the request (see the operation's errors), or something failed inside YoPrint. Refusals use the error envelope with a code such as action_not_allowed; an unexpected failure answers {"message": "Server Error"}. Repeating a refusal gets the same answer; after an unexpected failure, read the record back before you retry a change.

  When

  The status is a start or pre_production status. The body is the error envelope with error.code and error.message null.

  Fix

  Rename it instead, or move the start marker first with "Save a set of status changes". Nothing changed.

Related

• PATCHRestore a deleted status/v1/api/store/{team_slug}/setting/status/{id}/restore
• GETList every status, including deleted ones/v1/api/store/{team_slug}/setting/status

Example request

curl

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

Example response 200

Response

{
  "data": null,
  "status": 200,
  "success": true
}