Home > API Reference > Document Package > Share Document Package

Share Document Package

Business applications can use this service API to share a document package with the signers and start a new workflow. The document should already have been prepared by applying a template and optionally updating the users and actions defined in template. The package ID to be shared is provided in the resource URL.

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

HTTP Verb

POST

Content-Type

application/json

Accept

application/json

Authorization

Bearer {access_token}

Request Body

 

Status Code

Message

Response Body

200

OK

[
   {
      "package_id": 12,
      "documents": [
         123,
         124,
         125
      ]
   },
   {
      "package_id": 13,
      "documents": [
         123,
         124,
         125
      ]
   },
   {
      "package_id": 14,
      "documents": [
         123,
         124,
         125
      ]
   }
]

401

Unauthorized

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

403

Forbidden

{
  "Message": "Document does not belong to user"
}
{
  "Message": "Document is no longer in draft state"
}
{
   "Message": "Enterprise admin's role does not allow managing integration"
}
{
  "Message": "You are not allowed to perform the requested operation"
}
{
   "Message": "Account is disabled"
}
{
   "Message": "Your workflows limit has been reached"
}

404

Not Found

{
  "Message": "Document not found"
}
{
  "Message": "Document does not exist"
}
{
  "Message": "You must add 1 or more signers before sharing the document"
}

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
The document package to be shared. 

 Response Parameters
 package_id Package ID of the package just shared. Incase of individual sharing, more then one packages are created and shared with the recipients. API returns an array of packages along with IDs of newly created documents. 

 documents Array of document IDs which were part of the package before sharing. 

 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
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
Delete Package
Download Package
Download Package (base64)
Open Document Package
Close Document Package