Home > API Reference > Document Package > Delete Package

Delete Package

Business applications can use this service API to delete a document from the user inbox. The package ID is provided in the resource URL as "{package_id}". If the document status is PENDING, then it is automatically declined as result of delete operation. If the document status is SHARED, then the document is automatically recalled and workflow is stopped before the document is deleted.

https://api.signinghub.com/v3/packages/{package_id}    

HTTP Verb

DELETE

Content-Type

application/json

Accept

application/json

Authorization

Bearer {access_token}

Request Body

 

Status Code

Message

Response Body

200

OK

 

401

Unauthorized

{
  "Message": "Request authorization denied"
}
{
  "Message": "User authentication required"
}

403

Forbidden

{
  "Message": "Document does not belong to user"
}
{
   "Message": "Account is disabled"
}

404

Not Found

{
  "Message": "Document not found"
}

500

Internal Server Error

{
  "Message": "An internal server error occurred while processing the request"
}

The detail of each item provided in the request and response is provided below:

 Item Details
 Names
 Description
 Request Parameters
 access_token The access token obtained as a result of successful authentication. If "scope" parameter was used in authentication request, then this service requires the access token to be obtained using the credentials of an Enterprise admin whose enterprise role has the application integration privileges.

 package_id Package ID of the package which contains the document. 

 Response Parameters
 Message The service specific error message returned by the API. This message provides useful information about why the service has returned an error response.



See also
Add Package
Rename Package
Upload Document
Add Document from Library
Apply Workflow Template
Share Document Package
Change Document Package Owner
Get Document Details
Get Document Image
Get Document Image (base64)
Download Document
Download Document (base64)
Rename Document
Delete Document
Get Certify Policy for a document
Update Certify Policy for a document
Get Package Verification
Get Document Verification
Change Document Order
Get Packages
Download Package
Download Package (base64)
Open Document Package
Close Document Package