Reminders

This section describes the following services related to Reminders:

This guide’s REST API chapter provides an overview of certain basic API calls. If you want to view all existing calls, see the REST API Object Model. Additional information about the calls can be found on the Developer Community website. That site’s Feature Guides may be especially helpful when you’re building your solution.

Retrieve a Package's Reminder Schedule

GET /packages/{packageId}/reminders

Description

Retrieve the Reminder Schedule of a package (if it exists).

Resource Information

HTTP Method GET
Resource Family reminders
Authentication Authentication Tokens
Content-type application/json
Accept application/json

Path Parameters

packageId Unique identifier of a OneSpan Sign package

Example Request

GET https://sandbox.e-signlive.com/api/packages/256728de-fb3c-431e-aa70-75a311c01fa5/reminders

Update a Package's Reminder Schedule

PUT /packages/{packageId}/reminders

Description

Update the Reminder Schedule of a package.

This resource is not available for packages whose status is SENT.

Resource Information

HTTP Method PUT
Resource Family reminders
Authentication Authentication Tokens
Content-type application/json
Accept application/json

Path Parameters

packageId Unique identifier of a OneSpan Sign package

Example Request

PUT https://sandbox.e-signlive.com/api/packages/063829e2-ae92-4b27-874d-c51b41d0acd0/reminders

Create a Reminder Schedule for a Package

POST /packages/{packageId}/reminders

Description

Create a Reminder Schedule for a package. The user can only create a reminder schedule on packages that are not yet sent. All reminders are created automatically by the system at the time when a package is sent.

This resource is not available for packages whose status is SENT.

Resource Information

HTTP Method POST
Resource Family reminders
Authentication Authentication Tokens
Content-type application/json
Accept application/json

Path Parameters

startInDaysDelay The time the next reminder is scheduled to send the package
Date The exact time the package is sent
sentDate The real date the reminder was sent
repetitionCount The number of repetitions
packageId Unique identifier of a OneSpan Sign package

Example Request

POST https://sandbox.e-signlive.com/api/packages/063829e2-ae92-4b27-874d-c51b41d0acd0/reminders

Delete a Package's Reminder Schedule

DELETE /packages/{packageId}/reminders

Description

Delete the Reminder Schedule of a package.

Resource Information

HTTP Method DELETE
Resource Family reminders
Authentication Authentication Tokens
Content-type application/json
Accept application/json

Path Parameters

packageId Unique identifier of a OneSpan Sign package

Example Request

DELETE https://sandbox.e-signlive.com/api/packages/063829e2-ae92-4b27-874d-c51b41d0acd0/reminders

Response Payload

no content