Skip to content

Latest commit

 

History

History
26 lines (22 loc) · 3.24 KB

TemplateResponse.md

File metadata and controls

26 lines (22 loc) · 3.24 KB
Raw

TemplateResponse

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

Properties

Name Type Description Notes
template_id str The id of the Template.
title str 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 str 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_at int Time the template was last updated.
is_embedded bool 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_creator bool true if you are the owner of this template, false if it's been shared with you by a team member.
can_edit bool Indicates whether edit rights have been granted to you by the owner (always true if that's you).
is_locked bool 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 object The metadata attached to the template.
signer_roles List[TemplateResponseSignerRole] An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template.
cc_roles List[TemplateResponseCCRole] An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template.
documents List[TemplateResponseDocument] An array describing each document associated with this Template. Includes form field data for each document.
custom_fields List[TemplateResponseDocumentCustomFieldBase] Deprecated. Use custom_fields inside the documents array instead.
named_form_fields List[TemplateResponseDocumentFormFieldBase] Deprecated. Use form_fields inside the documents array instead.
accounts List[TemplateResponseAccount] An array of the Accounts that can use this Template.
attachments List[SignatureRequestResponseAttachment] Signer attachments.

[Back to Model list] [Back to API list] [Back to README]