Recall Document - SigningHub-APIGuide

Business applications can use this service API to stop a workflow in progress. The document ID is provided in the resource URL. After recall the document status automatically changes to “DRAFT”.

https://api.signinghub.com/v3/packages/{package_id}/workflow
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":` `"You are not allowed to perform the requested operation"` `}`
		`{` `"Message":` `"Document should be recalled by owner in In Progress or Pending state"` `}`
		`{` `"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	The ID of the package to be recalled.
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.