Update Workflow User - SigningHub-APIGuide

Business applications can use this service API to update the details of a recipient, group or place holder who has already been added to a workflow. Normally this call is useful after a template has been applied to a document and business applications wants to override the details of a specific user within the workflow. The ID of the workflow document is provided in the resource URL, and the workflow recipient is identified by the order at which it is added to the workflow. Note, while XML type document preparation, only supports role types "SIGNER", "REVIEWER" and "CARBON_COPY".

https://api.signinghub.com/v3/packages/{package_id}/workflow/{order}/user
HTTP Verb		PUT
Content-Type		application/json
Accept		application/json
Authorization		Bearer {access_token}
Request Body		`{` `"user_email":` `"chris@ascertia.com",` `"user_name":` `"chris",` `"role":` `"SIGNER",` `"email_notification":` `true,` `"signing_order": 3` `}`
Status Code	Message	Response Body
200	OK
400	Bad Request	`{` `"Message":` `"Recipient role is not supported for an XML type document"` `}`
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":` `"You are not allowed to perform the requested operation"` `}`
		`{` `"Message":` `"You cannot access this document after the access period ends"` `}`
		`{` `"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 user needs to be updated.
order	The order of the user in workflow.
user_email (optional)	The email address of the new user to be updated in workflow. If no value is provided, old value will be retained.
user_name (optional)	Name of the recipient to be updated. If no value is provided, old value will be retained.
role (optional)	Role of the recipient to be updated. Possible values are "SIGNER", "REVIEWER", "EDITOR","CARBON_COPY" or "INPERSON_HOST". If no value is provided, old value will be retained. However, while XML type document preparation, only supported role types are "SIGNER", "REVIEWER" and "CARBON_COPY"
email_notification (optional)	Setting its value to "true" sends an email notification to the user when its turn arrives in workflow. Setting its value to "false" does not send the email notification to the user on its turn. If no value is provided, old value will be retained.
signing_order (optional)	Order in which the workflow will be signed by the recipients. This signing order is important when workflow type is set to "CUSTOM".
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.