×
TemplateContains information about the templates you and your team have createdContains information about the templates you and your team have created
Template
Response Object.
template_id
The id of the Template.
title
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
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.
metadata
The metadata attached to the template.
signer_roles
An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template.
name
The name of the Role.
order
If signer order is assigned this is the 0-based index for this role.
cc_roles
An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template.
name
The name of the Role.
documents
An array describing each document associated with this Template. Includes form field data for each document.
name
Name of the associated file
index
Document ordering, the lowest index is displayed first and the highest last.
field_groups
An array of Form Field Group objects.
name
The name of the form field group.
rule
The rule used to validate checkboxes in the form field group. See checkbox field grouping.
form_fields
An array of Form Field objects containing the name and type of each named textbox and checkmark field.
api_id
A unique id for the form field.
name
The name of the form field.
type
The type of this form field. See field types.
x
The horizontal offset in pixels for this form field.
y
The vertical offset in pixels for this form field.
width
The width in pixels of this form field.
height
The height in pixels of this form field.
required
Boolean showing whether or not this field is required.
group
The name of the group this field is in. If this field is not a group, this defaults to null.
custom_fields
An array of Custom Field objects
name
The name of the Custom Field.
type
The type of this Custom Field. Only 'text' and 'checkbox' are currently supported.
x
The horizontal offset in pixels for this field.
y
The vertical offset in pixels for this field.
width
The width in pixels of this field.
height
The height in pixels of this field.
required
Boolean showing whether or not this field is required.
group
The name of the group this field is in. If this field is not a group, this defaults to null.
avg_text_length
Average text length in custom field.
num_lines
Number of lines.
num_chars_per_line
Number of character per line.
named_form_fields
DEPRECATED Use "form_fields" under the "documents" array instead.
reusable_form_id
DEPRECATED
accounts
An array of the Accounts that can use this Template.
account_id
The id of the Account.
email_address
The email address associated with the Account.
is_locked
Returns true if the user has been locked out of their account by a team admin.
is_paid_hs
Returns true if the user has a paid HelloSign account.
is_paid_hf
Returns true if the user has a paid HelloFax account.
quotas
An object detailing remaining monthly quotas.
templates_left
API templates remaining.
api_signature_requests_left
API signature requests remaining.
documents_left
Signature requests remaining.
is_creator
True if you are the owner of this template, false if it's been shared with you by a team member.
is_embedded
True if this template was created using an embedded flow, false if it was created on our website.
can_edit
Indicates whether edit rights have been granted to you by the owner (always true if that's you).
is_locked
True if you exceed Template quota; these can only be used in test mode. False if the template is included with the Template quota; these can be used at any time.
ACTION
URI - Description
Create Embedded Template Draft
POST /template/create_embedded_draft
Creates an embedded template draft for further editing.Description
The first step in an embedded template workflow. Creates a draft template that can then be further set up in the template 'edit' stage.
Request Parameters
test_mode optional
Whether this is a test, the signature request created from this draft will not be legally binding if set to 1. Defaults to 0.
client_id
Client id of the app you're using to create this draft.
file[] OR file_url[]
Use file[] to indicate the uploaded file(s) to use for the template. Use file_url[] to have HelloSign download the file(s) to use for the template. Currently we only support use of either the file[] parameter or file_url[] parameter, not both.
title optional
The template title
subject optional
The template title (alias)
message optional
The default template email message
signer_roles[%i%][name]
The role name of the signer that will be displayed when the template is used to create a signature request. %i% is an integer that should uniquely identify a signer role.
signer_roles[%i%][order] optional
The order in which this signer role is required to sign. %i% is an integer that should uniquely identify a signer role.
attachments[%i%][name] optional
The name of attachment.
attachments[%i%][instructions] optional
The instructions for uploading the attachment.
attachments[%i%][signer_index] optional
The signer's unique number, see signers[%i%][name] for more details.
attachments[%i%][required] optional
Determines if the attachment must be uploaded.
cc_roles[] optional
The CC roles that must be assigned when using the template to send a signature request
merge_fields optional
The merge fields that can be placed on the template's document(s) by the user claiming the template draft. These are typically fields that can be pre-populated by your application when using the resulting template to send a signature request. Each merge field object must have two parameters: name and type. Names must be unique and type can only be "text" or "checkbox".
skip_me_now optional
Disables the "Me (Now)" option for the person preparing the document. Defaults to 0.
use_preexisting_fields optional
[boolean] Enable the detection of predefined PDF fields by setting the use_preexisting_fields to "1" (defaults to disabled, or "0").
metadata[%key%] optional
Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.
Each request can include up to 10 metadata keys, with key names up to 40 characters long and values up to 1000 characters long.
Each request can include up to 10 metadata keys, with key names up to 40 characters long and values up to 1000 characters long.
allow_reassign optional
Allows signers to reassign their signature requests to other signers if set to 1. Defaults to 0. Note: Only available for Gold plan and higher.
allow_ccs optional
This allows the requester to specify whether the user is allowed to provide email addresses to CC when creating a template
field_options optional
This allows the requester to specify field options for signature requests created using the template.
- date_format: [string] allows requester to specify the date format (see list of allowed formats)
Note: Only available for Platinum and higher.
editor_options optional
This allows the requester to specify editor options when a preparing a document.
- allow_edit_signers: [boolean] allows requesters to edit the list of signers (default: false)
- allow_edit_documents: [boolean] allows requesters to edit documents, including delete and add (default: false)
Response
Returns a Template object with parameters : "template_id", "edit_url", "expires_at"
Example request / response
POST https://[api
key]:@api.hellosign.com/v3/template/create_embedded_draft
test_mode = 1
client_id = 37dee8d8440c66d54cfa05d92c160882
file[0] = @NDA.pdf
title = Test Template
subject = Please sign this document
message = For your approval.
signer_roles[0][name] = Client
signer_roles[0][order] = 0
signer_roles[1][name] = Witness
signer_roles[1][order] = 1
cc_roles[0] = Manager
merge_fields = [{"name":"Full Name","type":"text"},{"name":"Is Registered?","type":"checkbox"}]
field_options = {"date_format": "DD - MM - YYYY"}
client_id = 37dee8d8440c66d54cfa05d92c160882
file[0] = @NDA.pdf
title = Test Template
subject = Please sign this document
message = For your approval.
signer_roles[0][name] = Client
signer_roles[0][order] = 0
signer_roles[1][name] = Witness
signer_roles[1][order] = 1
cc_roles[0] = Manager
merge_fields = [{"name":"Full Name","type":"text"},{"name":"Is Registered?","type":"checkbox"}]
field_options = {"date_format": "DD - MM - YYYY"}