Create Embedded Unclaimed Draft
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.
Request body
Use files[] to indicate the uploaded file(s) to send for signature.
This endpoint requires either files or file_urls[], but not both.
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.
This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft.
Allows signers to decline to sign a document if true. Defaults 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.
The email addresses that should be CCed.
Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app.
Provide users the ability to review/edit the signers.
Provide users the ability to review/edit the subject and message.
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.
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.
The request created from this draft will also be signable in embedded mode if set to true. Defaults to false.
The custom message in the email that will be sent to the signers.
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.
The email address of the user that should be designated as the requester of this draft, if the draft type is request_signature.
The URL you want signers redirected to after they successfully request a signature.
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.
When only one step remains in the signature request process and this parameter is set to false then the progress stepper will be hidden.
The URL you want signers redirected to after they successfully sign.
Disables the "Me (Now)" option for the person preparing the document. Does not work with type send_document. Defaults to false.
The subject in the email that will be sent to the signers.
Whether this is a test, the signature request created from this draft will not be legally binding if set to true. Defaults to false.
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.
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.
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.
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.
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
successful operation