Update Workflow User Permissions - SigningHub-APIGuide

Business applications can use this service API to update the workflow permissions for a user that has already been added to a workflow. Normally this call is useful after a template has been applied to a document and business applications want to override the permissions within the workflow. The ID of the document package is provided in the resource URL, and the workflow user is identified by the order at which it is added to the workflow.

https://api.signinghub.com/v3/packages/{package_id}/workflow/{order}/permissions
HTTP Verb		PUT
Content-Type		application/json
Accept		application/json
Authorization		Bearer {access_token}
Request Body		`{` `"apply_to_all":` `false,` `"permissions": {` `"print":` `true,` `"download":` `false,` `"add_text":` `true,` `"add_attachment":` `false,` `"change_recipients":` `true,` `"legal_notice": {` `"enabled":` `true,` `"legal_notice_name":` `"legal notice 1"` `}` `}` `}`
Status Code	Message	Response Body
200	OK
401	Unauthorized	`{` `"Message":` `"Request authorization denied"` `}`
		`{` `"Message":` `"User authentication required"` `}`
403	Forbidden	`{` `"Message":` `"Document is no longer in draft state"` `}`
		`{` `"Message":` `"Document does not belong to user"` `}`
		`{` `"Message":` `"You are not allowed to perform this action on locked workflow"` `}`
		`{` `"Message":` `"You are not allowed to change recipient"` `}`
		`{` `"Message":` `"Account is disabled"` `}`
404	Not Found	`{` `"Message":` `"Document not found"` `}`
		`{` `"Message":` `"No user found at given order"` `}`
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 permissions to be updated.
order	The order of the recipient for which the workflow permissions to be updated.
apply_to_all	True, if the permissions are to be applied on all the recipients in the workflow.
permissions > print (optional)	It defines whether recipient is allowed to print the document.
permissions > download (optional)	It defines whether recipient is allowed to download the document.
permissions > add_text (optional)	It defines whether recipient is allowed to add text fields in the document.
permissions > add_attachment (optional)	It defines whether recipient is allowed to add attachments in the PDF document.
permissions > change_recipient (optional)	It allows the user to change any recipient who has not signed yet.
permissions > legal_notice (optional)	The legal notice shown to recipient and agreed by the recipient before recipient signs the document.
permissions > legal_notice > enabled (optional)	True, if legal notice is enabled.
permissions > legal_notice > legal_notice_name (optional)	Name of the legal notice selected for the recipient.
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.