OPENAPI / COMPONENTS / SCHEMAS

Template Response

TemplateResponse

Contains information about the templates you and your team have created.

object16properties
template_idstring

The id of the Template.

titlestring

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.

messagestring

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.

updated_atinteger

Time 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_editboolean

Indicates whether edit rights have been granted to you by the owner (always `true` if that's you).

is_lockedboolean

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.

metadataobject

The metadata attached to the template.

signer_rolesTemplateResponseSignerRole

An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template.

cc_rolesTemplateResponseCCRole

An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template.

documentsTemplateResponseDocument

An array describing each document associated with this Template. Includes form field data for each document.

custom_fieldsTemplateResponseDocumentCustomFieldBase

Deprecated. 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_fieldsTemplateResponseDocumentFormFieldBase

Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead.

accountsTemplateResponseAccount

An array of the Accounts that can use this Template.

attachmentsSignatureRequestResponseAttachment

Signer attachments.