Added

Retrieve the details of a Template from the API

You can now retrieve the details of a Template with the new Fetch a Template endpoint, without opening the Template in the app.

Use it before creating a Signature Request from a Template to know exactly what you must provide.

The response returns:

  • The Template metadata: name, description, status, workspace_id, created_at and updated_at.
  • The settings a Signature Request created from the Template inherits: expiration_delay, custom_experience_id, email_notification and labels.
  • A placeholders object listing everything the Template leaves blank: documents, signers and read_only_text_fields.

The placeholders object mirrors template_placeholders in Initiate a new Signature Request. Send each label back as is to fill the matching placeholder:

"placeholders": {
  "documents": [
    { "name": "Salary appendix" }
  ],
  "signers": [
    { "label": "Employee" }
  ],
  "read_only_text_fields": [
    { "label": "Salary", "text": "45,000 EUR gross per year" }
  ]
}

On a Template, expiration_delay is a relative delay expressed as {unit, value}. The expiration_date of the Signature Request is computed from it when the request is activated.

Workflow Templates and Forms Templates are not available through the API. Requesting one returns a 404 error.

📘

Available on the Plus, Pro and Scale plans, in both production and sandbox.

Read the guide: Use Templates to create Signature Requests