Create Embedded Template Draft
The first step in an embedded template workflow. Creates a draft template that can then be further set up in the template 'edit' stage.
Your API key can be used to make calls to the Dropbox Sign API. See Authentication for more information.
ā
Supported by Try it console (calls sent in test_mode only).
In: header
Use files[] to indicate the uploaded file(s) to send for signature.
This endpoint requires either files or file_urls[], but not both.
Use file_urls[] to have Dropbox Sign download the file(s) to send for signature.
This endpoint requires either files or file_urls[], but not both.
This allows the requester to specify whether the user is allowed to provide email addresses to CC when creating a template.
trueAllows signers to reassign their signature requests to other signers if set to true. Defaults to false.
NOTE: Only available for Premium plan and higher.
falseA list describing the attachments
The CC roles that must be assigned when using the template to send a signature request
Client id of the app you're using to create this draft. Used to apply the branding and callback url defined for the app.
This allows the requester to specify editor options when a preparing a document
This allows the requester to specify field options for a signature request.
Provide users the ability to review/edit the template signer roles.
falseProvide users the ability to review/edit the template subject and message.
falseGroup information for fields defined in form_fields_per_document. String-indexed JSON array with group_label and requirement keys. form_fields_per_document must contain fields referencing a group defined in form_field_groups.
Conditional Logic rules for fields defined in form_fields_per_document.
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.
- Text Field use
SubFormFieldsPerDocumentText - Dropdown Field use
SubFormFieldsPerDocumentDropdown - Hyperlink Field use
SubFormFieldsPerDocumentHyperlink - Checkbox Field use
SubFormFieldsPerDocumentCheckbox - Radio Field use
SubFormFieldsPerDocumentRadio - Signature Field use
SubFormFieldsPerDocumentSignature - Date Signed Field use
SubFormFieldsPerDocumentDateSigned - Initials Field use
SubFormFieldsPerDocumentInitials - Text Merge Field use
SubFormFieldsPerDocumentTextMerge - Checkbox Merge Field use
SubFormFieldsPerDocumentCheckboxMerge
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 custom_fields parameter.
If the signature request using that template does not pass a value into a merge field, then an empty field remains in the document.
The default template email message.
length <= 5000Key-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.
items <= 10This allows the requester to enable the editor/preview experience.
show_preview=true: Allows requesters to enable the editor/preview experience.show_preview=false: Allows requesters to disable the editor/preview experience.
falseWhen only one step remains in the signature request process and this parameter is set to false then the progress stepper will be hidden.
trueAn array of the designated signer roles that must be specified when sending a SignatureRequest using this Template.
Disables the "Me (Now)" option for the person preparing the document. Does not work with type send_document. Defaults to false.
falseThe template title (alias).
length <= 200Whether this is a test, the signature request created from this draft will not be legally binding if set to true. Defaults to false.
falseThe title you want to assign to the SignatureRequest.
Enable the detection of predefined PDF fields by setting the use_preexisting_fields to true (defaults to disabled, or false).
falseSent with a value of true to ignore the validation errors from text tags extraction. Defaults to false.
falseResponse Body
application/json
application/json
curl -X POST "https://example.com/template/create_embedded_draft" \ -H "Content-Type: application/json" \ -d '{ "client_id": "37dee8d8440c66d54cfa05d92c160882", "file_urls": [ "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" ], "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", "edit_url": "https://app.hellosign.com/editor/embeddedTemplate?token=8d80ead273a0405d6844005a20beb99b&root_snapshot_guids%5B0%5D=74cc144a76afa5bdca3378278e9a6ac3c2947c92&snapshot_access_guids%5B0%5D=9ceac764&guid=61a832ff0d8423f91d503e76bfbcc750f7417c78", "expires_at": 1427306768 }}Create Template POST
Creates a template that can be used in future signature requests. If `client_id` is provided, the template will be created as an embedded template. Embedded templates can be used for embedded signature requests and can be edited later by generating a new `edit_url` with [/embedded/edit_url/{template_id}](https://developers.hellosign.com/api/reference/operation/embeddedEditUrl/). Template creation may complete asynchronously after the initial request is accepted. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event indicates the template is ready to use, while a `template_error` event indicates there was a problem while creating the template. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary.
Delete Template POST
Completely deletes the template specified from the account.