The first step in an embedded template workflow. Creates a draft template that can then be further set up in the template 'edit' stage.
client_id required | string Client id of the app you're using to create this draft. Used to apply the branding and callback url defined for the app. |
files | Array of strings <binary> Use This endpoint requires either files or file_urls[], but not both. |
file_urls | Array of strings Use This endpoint requires either files or file_urls[], but not both. |
allow_ccs | boolean Default: true This allows the requester to specify whether the user is allowed to provide email addresses to CC when creating a template. |
allow_reassign | boolean Default: false Allows signers to reassign their signature requests to other signers if set to NOTE: Only available for Premium plan and higher. |
Array of objects (SubAttachment) A list describing the attachments | |
cc_roles | Array of strings The CC roles that must be assigned when using the template to send a signature request |
object (SubEditorOptions) This allows the requester to specify editor options when a preparing a document | |
object (SubFieldOptions) This allows the requester to specify field options for a signature request. | |
force_signer_roles | boolean Default: false Provide users the ability to review/edit the template signer roles. |
force_subject_message | boolean Default: false Provide users the ability to review/edit the template subject and message. |
Array of objects (SubFormFieldGroup) Group information for fields defined in | |
Array of objects (SubFormFieldRule) Conditional Logic rules for fields defined in | |
Array of objects (SubFormFieldsPerDocumentBase) The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: Using Form Fields per Document.) NOTE: Fields like text, dropdown, checkbox, radio, and hyperlink have additional required and optional parameters. Check out the list of additional parameters for these field types.
| |
Array of objects (SubMergeField) Add merge fields to the template. Merge fields are placed by the user creating the template and used to pre-fill data by passing values into signature requests with the | |
message | string <= 5000 characters The default template email message. |
object <= 10 items 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 (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | |
show_preview | boolean Default: false This allows the requester to enable the editor/preview experience.
|
show_progress_stepper | boolean Default: true When only one step remains in the signature request process and this parameter is set to |
Array of objects (SubTemplateRole) An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | |
skip_me_now | boolean Default: false Disables the "Me (Now)" option for the person preparing the document. Does not work with type |
subject | string <= 200 characters The template title (alias). |
test_mode | boolean Default: false Whether this is a test, the signature request created from this draft will not be legally binding if set to |
title | string The title you want to assign to the SignatureRequest. |
use_preexisting_fields | boolean Default: false Enable the detection of predefined PDF fields by setting the |
successful operation
failed_operation
{- "client_id": "37dee8d8440c66d54cfa05d92c160882",
- "title": "Test Template",
- "subject": "Please sign this document",
- "message": "For your approval",
- "signer_roles": [
- {
- "name": "Client",
- "order": 0
}, - {
- "name": "Witness",
- "order": 1
}
], - "cc_roles": [
- "Manager"
], - "merge_fields": [
- {
- "name": "Full Name",
- "type": "text"
}, - {
- "name": "Is Registered?",
- "type": "checkbox"
}
], - "field_options": {
- "date_format": "DD - MM - YYYY"
}, - "test_mode": true
}
{- "template": {
- "template_id": "61a832ff0d8423f91d503e76bfbcc750f7417c78",
- "expires_at": 1427306768
}
}