API ReferenceTemplate

Create Embedded Template Draft

View as Markdown
The first step in an embedded template workflow. Creates a draft template that can then be further set up in the template 'edit' stage.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <username:password>.

OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
client_idstringRequired
Client id of the app you're using to create this draft. Used to apply the branding and callback url defined for the app.
fileslist of stringsOptional

Use files[] to indicate the uploaded file(s) to send for signature.

This endpoint requires either files or file_urls[], but not both.

file_urlslist of stringsOptional

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.

allow_ccsbooleanOptionalDefaults to true
This allows the requester to specify whether the user is allowed to provide email addresses to CC when creating a template.
allow_reassignbooleanOptionalDefaults to false

Allows signers to reassign their signature requests to other signers if set to true. Defaults to false.

NOTE: Only available for Premium plan and higher.

attachmentslist of objectsOptional
A list describing the attachments
cc_roleslist of stringsOptional
The CC roles that must be assigned when using the template to send a signature request
editor_optionsobjectOptional
This allows the requester to specify editor options when a preparing a document
field_optionsobjectOptional
This allows the requester to specify field options for a signature request.
force_signer_rolesbooleanOptionalDefaults to false

Provide users the ability to review/edit the template signer roles.

force_subject_messagebooleanOptionalDefaults to false

Provide users the ability to review/edit the template subject and message.

form_field_groupslist of objectsOptional

Group 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.

form_field_ruleslist of objectsOptional

Conditional Logic rules for fields defined in form_fields_per_document.

form_fields_per_documentlist of objectsOptional
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](/docs/openapi/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](/api/reference/constants/#form-fields-per-document) 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`
merge_fieldslist of objectsOptional

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.

messagestringOptional<=5000 characters
The default template email message.
metadatamap from strings to anyOptional
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_previewbooleanOptionalDefaults to false
This 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.
show_progress_stepperbooleanOptionalDefaults to true

When only one step remains in the signature request process and this parameter is set to false then the progress stepper will be hidden.

signer_roleslist of objectsOptional
An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template.
skip_me_nowbooleanOptionalDefaults to false

Disables the “Me (Now)” option for the person preparing the document. Does not work with type send_document. Defaults to false.

subjectstringOptional<=200 characters

The template title (alias).

test_modebooleanOptionalDefaults to false

Whether this is a test, the signature request created from this draft will not be legally binding if set to true. Defaults to false.

titlestringOptional
The title you want to assign to the SignatureRequest.
use_preexisting_fieldsbooleanOptionalDefaults to false

Enable the detection of predefined PDF fields by setting the use_preexisting_fields to true (defaults to disabled, or false).

Response headers

X-RateLimit-Limitinteger
The maximum number of requests per hour that you can make.
X-RateLimit-Remaininginteger
The number of requests remaining in the current rate limit window.
X-Ratelimit-Resetinteger
The Unix time at which the rate limit will reset to its maximum.

Response

successful operation
templateobject

Template object with parameters: template_id, edit_url, expires_at.

warningslist of objects or null
A list of warnings.

Errors