5.16 Send Package Reminders
5.16.1 Description
Company policy might require that a document is handled within a given timespan. Triggering the “send reminders” call will look up everybody who hasn’t approved/signed and send them an extra notification as a reminder.
Note that only the next available approver(s)/signer(s) in the workflow are notified. This means approvers/signers waiting for someone else to sign first in a serial workflow will not receive a notification.
5.16.2 URL
https://[servername]:[port]/webportalapi/v3/packages/{id}/reminders
5.16.3 HTTP Method
POST
5.16.4 MIME Type
application/json
5.16.5 Request parameters
Parameter | Occurrence | Content / Description | Type |
---|---|---|---|
PackageId | Required | Unique id of the package | String |
5.16.6 Response parameters
Parameter | Content / Description | Type |
---|---|---|
None | Empty response body |
5.16.7 Response codes
Response status code | Description |
---|---|
200 OK | The reminders have been sent. |
404 Not Found | The package with the given id could not be found. |
409 Conflict | The package did not have status Pending. |
5.16.8 Error codes
HTTP code | Code |
---|---|
404 | Package.NotFound |
409 | Package.InvalidStatus |