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.

Securityapi_key or oauth2

Request

Request Body schema:
application/json

client_id required	string Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app.
requester_email_address required	string <email> The email address of the user that should be designated as the requester of this draft, if the draft type is `request_signature`.
files	Array of strings <binary> 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 of strings 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 Default: true This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft.
allow_decline	boolean Default: false Allows signers to decline to sign a document if `true`. Defaults to `false`.
allow_reassign	boolean Default: 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.
	Array of objects (SubAttachment) A list describing the attachments
cc_email_addresses	Array of strings <email> The email addresses that should be CCed.
	Array of objects (SubCustomField) 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.
	object (SubEditorOptions) This allows the requester to specify editor options when a preparing a document
	object (SubFieldOptions) This allows the requester to specify field options for a signature request.
force_signer_page	boolean Default: false Provide users the ability to review/edit the signers.
force_subject_message	boolean Default: false Provide users the ability to review/edit the subject and message.
	Array of objects (SubFormFieldGroup) 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`.
	Array of objects (SubFormFieldRule) Conditional Logic rules for fields defined in `form_fields_per_document`.
	Array of objects (SubFormFieldsPerDocumentBase) 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 Default: 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 walkthrough for more details.
hold_request	boolean Default: 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_signing	boolean Default: false The request created from this draft will also be signable in embedded mode if set to `true`. Defaults to `false`.
message	string <= 5000 characters The custom message in the email that will be sent to the signers.
	object <= 10 items 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_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 Default: 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.
	Array of objects (SubUnclaimedDraftSigner) Add Signers to your Unclaimed Draft Signature Request.
	object (SubSigningOptions) 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_url	string The URL you want signers redirected to after they successfully sign.
skip_me_now	boolean Default: false Disables the "Me (Now)" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`.
subject	string <= 200 characters The subject in the email that will be sent to the signers.
test_mode	boolean Default: 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`.
type	string Default: "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. Enum: "send_document" "request_signature"
use_preexisting_fields	boolean Default: false 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.
use_text_tags	boolean Default: false 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.
populate_auto_fill_fields	boolean Default: false 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.
expires_at	integer or null 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.

Responses

200

successful operation

4XX

failed_operation

Request samples

{"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
}

Response samples

application/json

{"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
}
}

Create Embedded Unclaimed Draft

Request Body schema: application/jsonmultipart/form-dataapplication/json

Request Body schema:
application/json