Delete an uploaded file

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

v1Operation ID v1_public_async_upload_destroy

Deletes a file. Use it to throw away an upload you no longer need.

To delete only if it is still unattached, send cleanup_only=true: if the file was attached in the meantime, nothing happens and the call still succeeds. Without it, the call deletes any file of your team, including one attached to a job, but not a job preset's file: remove that from the job preset in Settings.

Permission

Any member of the team.

Side effects

• The file is soft-deleted: it disappears from YoPrint.
• A job file in an open approval is deleted but stays in that approval, unless you send approval_request_action=remove_open_items.
• With remove_open_items, the file is taken out of every open job approval it is in. An open approval left with no items is removed; the others are updated, and open Customer Portal pages are told to refresh.
• With remove_open_items, or when no approval is open: a job file that past approvals refer to is kept for that history instead of being deleted.

Path parameters

• team_slugstringrequired

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

  • Example your-team
• hash_idstringrequired

  The file's id, from the upload answer. A hash id; unique keys and document numbers are refused with 404.

  • Example b0l2VJxwa3ppc7

Query parameters

• cleanup_onlyboolean

  true: delete only if the file is still an unattached upload.

  • Default false
• approval_request_actionstring

  For a job file in open approvals: also remove it from every open job approval.

  • One of: "remove_open_items"
  • Example remove_open_items

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

  Fix

  Use the id the upload returned.

• 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 file belongs to a job preset (error.code validation_error, "This file belongs to a job preset. Remove it from the job preset in Settings."). Nothing is deleted.

  Fix

  Remove the file from the job preset instead.

• 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 file could not be deleted (delete_fail, message null).

  Fix

  Read the file back before retrying.

Notes

• Prefer cleanup_only=true when you clean up after a failed attach, so you never delete a file someone attached.

Related

• POSTUpload a file/v1/api/store/{team_slug}/async_upload

Example request

curl

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