Unclaimed Draft

Create Embedded Unclaimed Draft

POST
/unclaimed_draft/create_embedded

Creates a new Draft 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.

Authorization

AuthorizationBasic <token>

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

Request Body

files?unknown

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

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

file_urls?array<string>

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_ccs?boolean

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

Defaulttrue
allow_decline?boolean

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

Defaultfalse
allow_reassign?boolean

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.

Defaultfalse
attachments?array<>

A list describing the attachments

cc_email_addresses?array<>

The email addresses that should be CCed.

client_id*string

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

custom_fields?array<>

When used together with merge fields, custom_fields allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with form_fields_per_document or Text Tags while passing values back with custom_fields together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling /template/create_embedded_draft and then passing custom_fields on subsequent signature requests referencing that template.

editor_options?

This allows the requester to specify editor options when a preparing a document

field_options?

This allows the requester to specify field options for a signature request.

force_signer_page?boolean

Provide users the ability to review/edit the signers.

Defaultfalse
force_subject_message?boolean

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

Defaultfalse
form_field_groups?array<>

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_rules?array<>

Conditional Logic rules for fields defined in form_fields_per_document.

form_fields_per_document?array<>

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
hide_text_tags?boolean

Send with a value of true if you wish to enable automatic Text Tag removal. Defaults to false. When using Text Tags it is preferred that you set this to false and hide your tags with white text or something similar because the automatic removal system can cause unwanted clipping. See the Text Tags walkthrough for more details.

Defaultfalse
hold_request?boolean

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

Defaultfalse
is_for_embedded_signing?boolean

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

Defaultfalse
message?string

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

Lengthlength <= 5000
metadata?

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.

Itemsitems <= 10
requester_email_address*string

The email address of the user that should be designated as the requester of this draft, if the draft type is request_signature.

Formatemail
requesting_redirect_url?string

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

show_preview?boolean

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_stepper?boolean

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

Defaulttrue
signers?array<>

Add Signers to your Unclaimed Draft Signature Request.

signing_options?

This allows the requester to specify the types allowed for creating a signature and specify another signing options.

NOTE: If signing_options are not defined in the request, the allowed types will default to those specified in the account settings.

NOTE: If force_advanced_signature_details is set, allowed types has to be defined too.

signing_redirect_url?string

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

skip_me_now?boolean

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

Defaultfalse
subject?string

The subject in the email that will be sent to the signers.

Lengthlength <= 200
test_mode?boolean

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

Defaultfalse
type?string

The type of the draft. By default this is request_signature, but you can set it to send_document if you want to self sign a document and download it.

Default"request_signature"

Value in

  • "send_document"
  • "request_signature"
use_preexisting_fields?boolean

Set use_text_tags to true to enable Text Tags parsing in your document (defaults to disabled, or false). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the use_preexisting_fields to true (defaults to disabled, or false). Currently we only support use of either use_text_tags or use_preexisting_fields parameter, not both.

Defaultfalse
use_text_tags?boolean

Set use_text_tags to true to enable Text Tags parsing in your document (defaults to disabled, or false). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the use_preexisting_fields to true (defaults to disabled, or false). Currently we only support use of either use_text_tags or use_preexisting_fields parameter, not both.

Defaultfalse
ignore_text_tags_extraction_errors?boolean

Sent with a value of true to ignore the validation errors from text tags extraction. Defaults to false.

Defaultfalse
populate_auto_fill_fields?boolean

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.

Defaultfalse
expires_at?|

When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See Signature Request Expiration Date for details.

NOTE: This does not correspond to the expires_at returned in the response.

Response Body

application/json

application/json

curl -X POST "https://example.com/unclaimed_draft/create_embedded" \  -H "Content-Type: application/json" \  -d '{    "client_id": "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a",    "file_urls": [      "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1"    ],    "requester_email_address": "jack@dropboxsign.com",    "test_mode": true  }'
{  "unclaimed_draft": {    "claim_url": "https://embedded.hellosign.com/prep-and-send/embedded-request?cached_params_token=30c4d8df776038c2fa5f7094c3718937",    "signing_redirect_url": null,    "expires_at": 1414093891,    "test_mode": true,    "signature_request_id": "340e9843ac552b5170ee9c374d67e312f53ca129",    "requesting_redirect_url": null  }}