Update Workflow Details - SigningHub-APIGuide

Business applications can use this service API to update the workflow details. Normally this call is useful after a template has been applied to a document, but business applications wants to override the certify permission or post processing details. The package ID is provided in the resource URL.

https://api.signinghub.com/v3/packages/{package_id}/workflow
HTTP Verb		PUT
Content-Type		application/json
Accept		application/json
Authorization		Bearer {access_token}
Request Body		`{` `"workflow_type":` `"SERIAL",` `"workflow_mode":` `"ONLY_ME",` `"continue_on_decline":` `false,` `"message":` `"Sign before July"` `}`
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":` `"You are not allowed to perform this action on locked workflow"` `}`
		`{` `"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 package ID for which workflow details need to be updated.
workflow_type (optional)	Workflow type for the package e.g (SERIAL,PARALLEL,INDIVIDUAL,CUSTOM). If no value is provided, old value will be retained.
workflow_mode (optional)	Workflow mode of the package e.g (ONLY_ME, ME_AND_OTHERS, ONLY_OTHERS). If workflow mode is set to ONLY_ME then no collaborator can be added to package other then authenticated user itself
continue_on_decline (optional)	True, if workflow needs to continue even if any recipient declines the document. If no value is provided, old value will be retained.
message (optional)	A custom string message from the document owner to every recipient, this message appears in the sharing email as well as on the screen. If no value is provided, old value will be retained.
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.