Update Post Processing
|
https://api.signinghub.com/v3/packages/{package_id}/workflow/post_process |
||
|
HTTP Verb |
PUT |
|
|
Authorization |
Bearer {access_token} |
|
|
Content-Type |
application/json |
|
|
Accept |
application/json |
|
|
Response Headers |
||
|
Request Body |
{ "enabled": true, "recipients": [ { "name": "John Miller", "email": "johnmiller@gmail.com" }, { "name": "Sam", "email": "Sam_hoods@gmail.com" } ], "message": "post process message here…", "workflow_recipients": true, "google_drive": true, "dropbox": true
|
|
|
Status Code |
Message |
Response Body |
|
200 |
OK |
|
| 403 | Forbidden |
{ "Message": "You are not allowed to perform this action on locked workflow"} |
{ "Message": "Account is disabled"} |
||
|
500 |
Internal Server Error |
{ "Message": "An internal server error occurred while processing the request"} |
| 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 | ID of the document package for which the post processing is being updated. |
| enabled |
True, if post processing is turned on for the package. |
| recipients | List of the name and email addresses to whom the emails are sent when the post processing is executed after the workflow completion. |
| message | A custom string message for all the contacts. Message becomes part of the email sent to the contacts. |
| workflow_recipients (optional) | True, if workflow completion report is to be sent to all recipients of the workflow when post processing is executed. Default value is false. |
| google_drive | True, if document is to be uploaded to the provided google account after the workflow completion. |
| dropbox | True, if document is to be uploaded to the provided dropbox account after the workflow completion. |
| 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. |