Update Workflow Reminders - SigningHub-APIGuide

Business applications can use this service API to update the workflow reminders for a recipient 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 reminders settings 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.

https://api.signinghub.com/v3/packages/{package_id}/workflow/{order}/reminders
HTTP Verb		PUT
Content-Type		application/json
Accept		application/json
Authorization		Bearer {access_token}
Request Body		{ `"apply_to_all":` `false,` `"enabled":` `true,` `"remind_after": 3,` `"repeat": {` `"enabled":` `true,` `"keep_reminding_after": 1,` `"total_reminders": 3` `}` `}`
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.
order	The order of the user for which the workflow reminders to be updated.
package_id	The package ID for which workflow reminders to be updated.
apply_to_all	True, if reminder settings are to be applied on all the recipients in the workflow.
enabled	True, if reminder settings are to be enabled.
remind_after	The number of days after which the first reminder would be sent to workflow user.
repeat > enabled	True, if subsequent reminders are enabled.
repeat > keep_reminding_after	The number of days after which the subsequent reminders would be sent to workflow user.
repeat > total_reminders	The number of subsequent reminders to be sent to workflow user.
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.