OPENAPI / COMPONENTS / SCHEMAS

Template Create Embedded Draft Request

TemplateCreateEmbeddedDraftRequest

TemplateCreateEmbeddedDraftRequest data structure

object25properties
filesarray

Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.

file_urlsarray

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_ccsboolean

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

allow_reassignboolean

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.

attachmentsSubAttachment

A list describing the attachments

cc_rolesarray

The CC roles that must be assigned when using the template to send a signature request

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.

editor_optionsSubEditorOptions

field_optionsSubFieldOptions

force_signer_rolesboolean

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

force_subject_messageboolean

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

form_field_groupsSubFormFieldGroup

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_rulesSubFormFieldRule

Conditional Logic rules for fields defined in `form_fields_per_document`.

form_fields_per_documentSubFormFieldsPerDocumentBase

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_fieldsSubMergeField

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.

messagestring

The default template email message.

metadataobject

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_previewboolean

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_stepperboolean

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_rolesSubTemplateRole

An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template.

skip_me_nowboolean

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

subjectstring

The template title (alias).

test_modeboolean

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

titlestring

The title you want to assign to the SignatureRequest.

use_preexisting_fieldsboolean

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