Sign in

v1

latestOpenAPI 3.0.3MIT2026-07-1373217576.0 KB
Unclaimed Draft

Create Embedded Unclaimed Draft with Template

Creates a new Draft with a previously saved template(s) that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the "Request signature" page with the Draft loaded. Subsequent access to the claim URL will result in a 404. For this embedded endpoint the requester_email_address parameter is required.

NOTE: Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign.

post/unclaimed_draft/create_embedded_with_template

Request body

allow_declineboolean

Allows signers to decline to sign a document if true. Defaults to false.

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.

client_idstring required

Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app.

filesstring[]

Use files[] to append additional files to the signature request being created from the template. Dropbox Sign will parse the files for text tags 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_urlsstring[]

Use 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, 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_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.

hold_requestboolean

The request from this draft will not automatically send to signers post-claim if set to 1. Requester must release the request from hold when ready to send. Defaults to false.

is_for_embedded_signingboolean

The request created from this draft will also be signable in embedded mode if set to true. Defaults to false.

messagestring

The custom message in the email that will be sent to the signers.

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.

preview_onlyboolean

This 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_addressstring email required

The email address of the user that should be designated as the requester of this draft.

requesting_redirect_urlstring

The URL you want signers redirected to after they successfully request a signature.

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.

signing_redirect_urlstring

The URL you want signers redirected to after they successfully sign.

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 subject in the email that will be sent to the signers.

template_idsstring[] required

Use template_ids to create a SignatureRequest from one or more templates, in the order in which the templates will be used.

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.

populate_auto_fill_fieldsboolean

Controls whether 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_ccsboolean

This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft.

Response

successful operation