Delete an approval

DELETE/v1/api/store/{team_slug}/approvals/{hash_id}

v1Operation ID v1_public_approvals_destroy

Deletes an approval that the customer has not completed yet, for good, with its mockup items. The customer's link stops working. Completed approvals (approved or changes requested) can't be deleted; they stay as the order's record.

Permission

Any member of the team.

Business rules

• Only approvals that are not completed can be deleted.

Side effects

• For an order approval, clears the order's approval status.
• People with the order open, and the customer's open Customer Portal pages, see the approval disappear. No email or webhook.

Path parameters

• team_slugstringrequired

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

  • Example your-team
• hash_idstringrequired

  The approval's id, from the approvals list. A hash id; unique keys and document numbers are refused with 404.

  • Example Fi0zPeMlwKadEo

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.

• 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 approval of this team has this id.

  Fix

  Use an id from the approvals list.

• 422The request was refused and changed nothing. validation_failed lists what to fix in error.fields; other codes name a business rule, explained in error.message. A few checks answer with only {"message": "..."}. An operation that calls another service (a payment provider, a carrier, an accounting app) can answer connect_timeout ("Please retry again") when that service does not answer in time: the change may or may not have happened there, so read the record back before you retry.

  When

  The approval is completed (approval_already_completed, "This approval has already been completed. You cannot remove completed approvals.").

  Fix

  Keep it. Create a new approval if the customer needs to review again.

  When

  The order came from Shopify (shopify_approval_workflow_locked).

  Fix

  Shopify orders do not use approvals in YoPrint.

Related

• GETList approvals/v1/api/store/{team_slug}/approvals
• DELETEDelete an order approval/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/approval/{hash_id2}

Example request

curl

curl -X DELETE 'https://secure.yoprint.com/v1/api/store/your-team/approvals/Fi0zPeMlwKadEo' \  -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
}