OPENAPI / COMPONENTS / SCHEMAS
Unclaimed Draft Create Embedded With Template Request
UnclaimedDraftCreateEmbeddedWithTemplateRequestUnclaimedDraftCreateEmbeddedWithTemplateRequest data structure
allow_declinebooleanAllows signers to decline to sign a document if `true`. Defaults to `false`.
allow_reassignbooleanAllows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher.
ccsSubCCAdd CC email recipients. Required when a CC role exists for the Template.
client_idstringrequiredClient id of the app used to create the draft. Used to apply the branding and callback url defined for the app.
custom_fieldsSubCustomFieldAn array defining values and options for custom fields. Required when a custom field exists in the Template.
editor_optionsSubEditorOptionsfield_optionsSubFieldOptionsfilesarrayUse `files[]` to append additional files to the signature request being created from the template. Dropbox Sign will parse the files for [text tags](https://app.hellosign.com/api/textTagsWalkthrough) and append it to the signature request. Text tags for signers not on the template(s) will be ignored. **files** or **file_urls[]** is required, but not both.
file_urlsarrayUse file_urls[] to append additional files to the signature request being created from the template. Dropbox Sign will download the file, then parse it for [text tags](https://app.hellosign.com/api/textTagsWalkthrough), and append to the signature request. Text tags for signers not on the template(s) will be ignored. **files** or **file_urls[]** is required, but not both.
force_signer_rolesbooleanProvide users the ability to review/edit the template signer roles.
force_subject_messagebooleanProvide users the ability to review/edit the template subject and message.
hold_requestbooleanThe request from this draft will not automatically send to signers post-claim if set to 1. Requester must [release](/api/reference/operation/signatureRequestReleaseHold/) the request from hold when ready to send. Defaults to `false`.
is_for_embedded_signingbooleanThe request created from this draft will also be signable in embedded mode if set to `true`. Defaults to `false`.
messagestringThe custom message in the email that will be sent to the signers.
metadataobjectKey-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.
preview_onlybooleanThis allows the requester to enable the preview experience (i.e. does not allow the requester's end user to add any additional fields via the editor). - `preview_only=true`: Allows requesters to enable the preview only experience. - `preview_only=false`: Allows requesters to disable the preview only experience. **NOTE:** This parameter overwrites `show_preview=1` (if set).
requester_email_addressstringrequiredThe email address of the user that should be designated as the requester of this draft.
requesting_redirect_urlstringThe URL you want signers redirected to after they successfully request a signature.
show_previewbooleanThis 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_stepperbooleanWhen only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden.
signersSubUnclaimedDraftTemplateSignerAdd Signers to your Templated-based Signature Request.
signing_optionsSubSigningOptionssigning_redirect_urlstringThe URL you want signers redirected to after they successfully sign.
skip_me_nowbooleanDisables the "Me (Now)" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`.
subjectstringThe subject in the email that will be sent to the signers.
template_idsarrayrequiredUse `template_ids` to create a SignatureRequest from one or more templates, in the order in which the templates will be used.
test_modebooleanWhether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`.
titlestringThe title you want to assign to the SignatureRequest.
populate_auto_fill_fieldsbooleanControls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.
allow_ccsbooleanThis allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft.