OPENAPI / COMPONENTS / SCHEMAS
Template Response
TemplateResponseContains information about the templates you and your team have created.
template_idstringThe id of the Template.
titlestringThe 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.
messagestringThe default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest.
updated_atintegerTime the template was last updated.
is_embeddedboolean`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.
is_creatorboolean`true` if you are the owner of this template, `false` if it's been shared with you by a team member.
can_editbooleanIndicates whether edit rights have been granted to you by the owner (always `true` if that's you).
is_lockedbooleanIndicates 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.
metadataobjectThe metadata attached to the template.
signer_rolesTemplateResponseSignerRoleAn array of the designated signer roles that must be specified when sending a SignatureRequest using this Template.
cc_rolesTemplateResponseCCRoleAn array of the designated CC roles that must be specified when sending a SignatureRequest using this Template.
documentsTemplateResponseDocumentAn array describing each document associated with this Template. Includes form field data for each document.
custom_fieldsTemplateResponseDocumentCustomFieldBaseDeprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead.
named_form_fieldsTemplateResponseDocumentFormFieldBaseDeprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead.
accountsTemplateResponseAccountAn array of the Accounts that can use this Template.
attachmentsSignatureRequestResponseAttachmentSigner attachments.