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.
| 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. |
| template_ids required | Array of strings Use |
| allow_decline | boolean Default: false Allows signers to decline to sign a document if |
| allow_reassign | boolean Default: false Allows signers to reassign their signature requests to other signers if set to NOTE: Only available for Premium plan and higher. |
Array of objects (SubCC) Add CC email recipients. Required when a CC role exists for the Template. | |
Array of objects (SubCustomField) An array defining values and options for custom fields. Required when a custom field exists in the 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. | |
| files | Array of strings <binary> Use files or file_urls[] is required, but not both. |
| file_urls | Array of strings 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_roles | boolean Default: false Provide users the ability to review/edit the template signer roles. |
| force_subject_message | boolean Default: false Provide users the ability to review/edit the template subject and message. |
| hold_request | boolean Default: false 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 |
| is_for_embedded_signing | boolean Default: false The request created from this draft will also be signable in embedded mode if set to |
| 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. | |
| preview_only | boolean Default: false 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).
NOTE: This parameter overwrites |
| requesting_redirect_url | string The URL you want signers redirected to after they successfully request a signature. |
| show_preview | boolean Default: false This allows the requester to enable 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 |
Array of objects (SubUnclaimedDraftTemplateSigner) Add Signers to your Templated-based Signature Request. | |
object (SubSigningOptions) This allows the requester to specify the types allowed for creating a signature. NOTE: If | |
| 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 |
| subject | string <= 255 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 |
| title | string <= 255 characters The title you want to assign to the SignatureRequest. |
| 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. |
| allow_ccs | boolean Default: false This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft. |
successful operation
failed_operation
{- "client_id": "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a",
- "template_ids": [
- "61a832ff0d8423f91d503e76bfbcc750f7417c78"
], - "requester_email_address": "jack@dropboxsign.com",
- "signers": [
- {
- "role": "Client",
- "name": "George",
- "email_address": "george@example.com"
}
], - "ccs": [
- {
- "role": "Accounting",
- "email_address": "accounting@dropboxsign.com"
}
], - "test_mode": false
}{- "unclaimed_draft": {
- "signature_request_id": "8e55b3880c62497791dda0f3b4181cfd95f7ddb4",
- "signing_redirect_url": null,
- "requesting_redirect_url": null,
- "test_mode": true
}
}