Contains information about the templates you and your team have created.
Name | Type | Description | Notes |
---|---|---|---|
templateId |
string |
The id of the Template. | |
title |
string |
The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | |
message |
string |
The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | |
updatedAt |
number |
Time the template was last updated. | |
isEmbedded |
boolean |
true if this template was created using an embedded flow, false if it was created on our website. Will be null when you are not the creator of the Template. |
|
isCreator |
boolean |
true if you are the owner of this template, false if it's been shared with you by a team member. |
|
canEdit |
boolean |
Indicates whether edit rights have been granted to you by the owner (always true if that's you). |
|
isLocked |
boolean |
Indicates whether the template is locked. If true , then the template was created outside your quota and can only be used in test_mode . If false , then the template is within your quota and can be used to create signature requests. |
|
metadata |
{ [key: string]: any; } |
The metadata attached to the template. | |
signerRoles |
Array<TemplateResponseSignerRole> |
An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | |
ccRoles |
Array<TemplateResponseCCRole> |
An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | |
documents |
Array<TemplateResponseDocument> |
An array describing each document associated with this Template. Includes form field data for each document. | |
customFields |
Array<TemplateResponseDocumentCustomFieldBase> |
Deprecated. Use custom_fields inside the documents array instead. |
|
namedFormFields |
Array<TemplateResponseDocumentFormFieldBase> |
Deprecated. Use form_fields inside the documents array instead. |
|
accounts |
Array<TemplateResponseAccount> |
An array of the Accounts that can use this Template. | |
attachments |
Array<SignatureRequestResponseAttachment> |
Signer attachments. |