Update Workflow User Authentication (Document Opening)

Business applications can use this service API to update the package authentications and access duration for the recipients.

https://api.signinghub.com/v3/packages/{package_id}/workflow/{order}/authentication
HTTP Verb		PUT
Content-Type		application/json
Accept		application/json
Authorization		Bearer {access_token}
Request Body		`{` `"apply_to_all":` `true,` `"authentication": {` `"enabled":` `true,` `"password": {` `"enabled":` `true,` `"user_password":` `""` `},` `"sms_otp": {` `"enabled":` `false,` `"mobile_number":` `"00445566778899"` `}` `},` `"access_duration": {` `"enabled":` `true,` `"duration_by_date": {` `"enabled":` `true,` `"duration": {` `"start_date_time":` `"2015-02-13T12:10:000Z",` `"end_date_time":` `"2015-02-28T12:10:000Z"` `}` `},` `"duration_by_days": {` `"enabled":` `false,` `"duration": {` `"total_days": 4` `}` `}` `}` `}`
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":` `"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 access security and authentication is to be updated.
order	Order of the recipient in the workflow for which the access security and authentication is to be updated.
apply_to_all	True, if the access security or authentications are to be applied on all the recipients in the workflow.
authentication > enabled	True, if authentication is enabled for the package.
authentication > password > enabled	True, if password authentication is enabled for the package.
authentication > password > user_password	Password string if password field is enabled. If a password is already set and owner do not wish to change it, remove the field from the response, or send null.
authentication > sms_otp > enabled	True, if SMS OTP authentication is enabled for the package.
authentication > sms_otp > mobile_number	Mobile number of the recipient. Mobile number is needed to send the SMS to the recipient for the authentication.
access_duration > enabled	True, if access duration security is enabled for the package.
access_duration > duration_by_date > enabled	True if access security is enabled for a duration by date and time.
access_duration > duration_by_date > duration > start_date_time	Date and time from where the package will be accessible to the recipient.
access_duration > duration_by_date > duration > end_date_time	Date and time after which the package will not be accessible to the recipient.
access_duration > duration_by_days > enabled	True, if access security is enabled for a duration by number of days.
access_duration > duration_by_days > duration > total_days	Total number of days for which the package will be accessible to the recipient after receiving the package.
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.