Templates

This section describes the following template-related services:

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.

Create a Template

POST /packages

Description

Creates a new template, based on a submitted payload.

Resource Information

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

Example Request

POST https://sandbox.e-signlive.com/api/packages/

Response Payload

{
    "id": "c9c6b8cb-ef6c-48b2-a83f-dad28ff24d1b"
}

Create a Template on Behalf of Another User

Creates a template on behalf of another user in your account. When you do this, you should specify that user manually, as this will prevent the creator of the template from being added to the template as a signer.

You can set the visibility element to either ACCOUNT or SENDER, depending on if you want the new package to be visible account-wide, or visible just to the sender. The default setting is ACCOUNT.

Create a Template from a Package

POST /packages/{packageId}/clone

Description

Creates a template  from an existing package , overriding the existing fields with those in the payload. If the new template requires a different sender, you can specify that sender manually when you clone the package.

You can set the visibility element to either ACCOUNT or SENDER, depending on if you want the new package to be visible account-wide, or visible just to the sender. The default setting is ACCOUNT.

Resource Information

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

Path Parameters

packageId Unique identifier of a OneSpan Sign package

Example Request

POST https://sandbox.e-signlive.com/api/packages/47132ca5-3687-4873-8ede-cc36eb93371d/clone

Response Payload

{
  "id": "3506c496-7b56-4fb5-9f9c-88bce25df1c2"
}

Delete a Template

DELETE /packages/{packageId}

Description

Deletes a template.

Resource Information

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

Required Parameters

packageId Unique identifier of a OneSpan Sign package

Example Request

DELETE https://sandbox.e-signlive.com/api/packages/75b125e1-ece3-481e-b8a6-3c2ae39d310a

Response Payload

no content