API ReferenceUnclaimed Draft

Create Embedded Unclaimed Draft

View as Markdown
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.

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 used to create the draft. Used to apply the branding and callback url defined for the app.
requester_email_addressstringRequiredformat: "email"

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

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 claiming the draft.
allow_declinebooleanOptionalDefaults to false

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

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_email_addresseslist of stringsOptional
The email addresses that should be CCed.
custom_fieldslist of objectsOptional
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](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) 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](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template.
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_pagebooleanOptionalDefaults to false

Provide users the ability to review/edit the signers.

force_subject_messagebooleanOptionalDefaults to false

Provide users the ability to review/edit the 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`
hide_text_tagsbooleanOptionalDefaults to false
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](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) walkthrough for more details.
hold_requestbooleanOptionalDefaults to false

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.

is_for_embedded_signingbooleanOptionalDefaults to false

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

messagestringOptional<=5000 characters
The custom message in the email that will be sent to the signers.
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.
requesting_redirect_urlstringOptional
The URL you want signers redirected to after they successfully request a signature.
show_previewbooleanOptional
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.

signerslist of objectsOptional
Add Signers to your Unclaimed Draft Signature Request.
signing_optionsobjectOptional

This allows the requester to specify the types allowed for creating a signature.

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

signing_redirect_urlstringOptional
The URL you want signers redirected to after they successfully sign.
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 subject in the email that will be sent to the signers.
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.

typeenumOptionalDefaults to request_signature

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.

Allowed values:
use_preexisting_fieldsbooleanOptionalDefaults to false
Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) 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.
use_text_tagsbooleanOptionalDefaults to false
Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) 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.
populate_auto_fill_fieldsbooleanOptionalDefaults to false
Controls 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.
expires_atinteger or nullOptional
When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. **NOTE:** This does not correspond to the **expires_at** returned in the response.

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
unclaimed_draftobject
A group of documents that a user can take ownership of via the claim URL.
warningslist of objects or null
A list of warnings.

Errors