The Template object
A template is a reusable resource in Annature that allows you to generate envelopes without redefining documents, recipients, and fields each time.
Templates streamline envelope creation for common workflows — such as NDAs, onboarding documents, or client agreements — by allowing you to predefine structure, roles, and field placement once, then reuse those settings as needed.
Like envelopes, templates must include at least one document and one role. Roles act as placeholder recipients and are resolved at the time the template is used.
Template documents
Each template contains one or more base documents. When creating an envelope from a template, you can choose to:
- Use the template’s original documents exactly as they are; or
- Replace one or more documents with updated versions — such as prefilled contracts or customised forms.
Replacement documents must meet two criteria:
- They must have the same number of pages as the originals. This ensures that all fields can be correctly reapplied to the new document structure.
- Their dimensions must be nearly identical to the original pages. This is required to maintain accurate field positioning — especially for coordinate-placed or anchored fields.
If these requirements are not met, field transfer will be incomplete or fail silently. For example, fields assigned to page 6 of the original document cannot be carried over if the replacement document only has 5 pages.
This workflow is designed for use cases where the layout stays the same, but content is prefilled externally — such as merging client data into a standard contract before sending.
There is no restriction on adding new documents beyond those defined in the template.
Template roles
Roles define placeholder recipients for the template. Each role specifies a set of fields and default recipient properties (such as signing order or message content).
When using the template, you’ll provide recipient details (name, email, etc.) and map them to the appropriate role by referencing the role’s id
. This allows Annature to copy the role’s properties and apply its fields to the matching recipient.
Attributes
The unique identifier for the template.
The name of the template as shown in the Annature dashboard.
Indicates whether the template is shared with other accounts in the same group as the creator.
Default name applied to envelopes created from this template.
Default message body applied to envelopes created from this template.
Default value for the shared
property when an envelope is created from this template.
The ISO 8601 timestamp indicating when the template was created.
The unique identifier of the account that created the template.
The unique identifier of the group the template is assigned to.
If shared
is true
, other accounts in this group will have access to use the template.
An array of document objects defined within the template.
An array of role objects representing placeholder recipients and their associated fields.