Add Package - SigningHub-APIGuide

This service API is used to add/create a document package to hold one or more documents. This package can then be used to add documents and recipients in order to start a new workflow.

As previously stated, this call is mandatory if you wish to work with documents. A package must exist before you can upload or add documents to SigningHub.

Even single documents are part of package: a package containing one document.

Note a package can be renamed if required once created.

https://api.signinghub.com/v3/packages
HTTP Verb		POST
Authorization		Bearer {access_token}
Content-Type		application/json
Accept		application/json
Response Headers
Request Body		`{` `"package_name":` `"New Package",` `"workflow_mode":` `"ONLY_ME"` `}`
Status Code	Message	Response Body
200	OK	`{` `"package_id": 123,` `"workflow_mode":` `"ONLY_ME",` `"workflow_type":` `"SERIAL"` `}`
403	Forbidden	`{` `"Message":` `"You are not allowed to perform the requested operation"` `}`
		`{` `"Message":` `"Account is disabled"` `}`
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_name	The name of the package. Default package name is always "Untitled" if the package_name is not provided.
workflow_mode	Mode of the workflow, there are three types of workflow modes supported in application. Possible values are "ONLY_ME", "ME_AND_OTHERS" and "ONLY_OTHERS"
Response Parameters
package_id	The package ID to be used later to share, download and get status of the document.
workflow_mode	The workflow mode that is set while adding package.
workflow_type	Type of the workflow. Possible values are "SERIAL", "PARALLEL", "INDIVIDUAL" and "CUSTOM".
Message	The service specific error message returned by the API. This message provides useful information about why the service has returned an error response.