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 overriden 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 overriden when sending the SignatureRequest.
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 diplayed first and the highest last.
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.
custom_fields An array of Custom Field objects containing the name and type of each custom field.
name The name of the Custom Field.
type The type of this Custom Field. Only 'text' and 'checkbox' are currently supported.
named_form_fields DEPRECATED Use "form_fields" under the "documents" array instead.
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_creator True if you are the owner of this template, false if it's been shared with you by a team member.
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.
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.
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 default template email subject
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.
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".
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.
Response
Returns a Template object
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"}]
HelloSign
API
Products
The Fine Print
Trending Topics
HelloSign © 2017 Skyhigh Enterprise-Ready cloud services fully satisfy the most stringent requirements for data protection, identity verification, service security, business practices, and legal protection.
Made in San Francisco