Skip to main content

​
Overview

Users in iinked Sign can create reusable templates in the UI to quickly generate new signing packages for frequently used workflows. You can retrieve a list of available templates and apply a template when creating a package.

​
Steps

1

Get the template

You can retrieve a list of an organization members current templates by calling templates/list endpoint.
Request
GET /templates/list
{
    "memberId": "e4f0bce5-30fc-43c4-b9ee-364ff5b04dea",
    "sortBy": "last_used",
    "take": 100,
    "skip": 0
}
See the Templates list API for more information.

​
Manually getting template details

If you know the template you want to use, you can manually copy the template ID and signer roles from iinked Sign by navigating to the Templates section, selecting a template, and copying the ID from the URL and the roles from the editor.
2

Create package using the template

Once you have the template ID and signer roles, you can create a new package by calling the packages/add endpoint and setting the templateId.

​
Documents

All documents associated with the template will be included in the package. You can add additional documents by including them in the documents array.

​
Replacing documents

If you want to replace a document with a different file (e.g., a new version), upload the new file and add it to the documents array, setting either templateDocumentId or name to that of the template document you want to replace.This will swap out the document in the package while retaining all templated fields.

​
Signers

Associate template signers by setting the templateSignerId or templateRole for each signer in the signers array.

​
Recipients

Associate template recipients by setting the templateRecipientId or templateRole for each recipient in the recipients array.
Request
POST /packages/add
{
    "name": "From Template",
    "type": "concurrent",
    "templateId": "{{template_id}}",
    "state": "open",
    "signers": [
        {
            "templateRole": "Signer 1",
            "firstName": "Signer",
            "lastName": "One",
            "email": "{{signer_1_email}}",
            "mobileNumber": null
        }
    ],
    "recipients": [
        {
            "templateRole": "Recipient 1",
            "firstName": "Recipient",
            "lastName": "One",
            "email": "{{recipient_1_email}}",
            "mobileNumber": null
        }
    ],
    "documents": []
}