Creates a new Draft that can be claimed using the claim URL. The first authenticated user to access the URL will claim the Draft and will be shown either the "Sign and send" or the "Request signature" page with the Draft loaded. Subsequent access to the claim URL will result in a 404.
type required | string The type of unclaimed draft to create. Use |
files | Array of strings <binary> Use This endpoint requires either files or file_urls[], but not both. |
file_urls | Array of strings Use This endpoint requires either files or file_urls[], but not both. |
allow_decline | boolean Default: false Allows signers to decline to sign a document if |
Array of objects (SubAttachment) A list describing the attachments | |
cc_email_addresses | Array of strings <email> 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. |
Array of objects (SubCustomField) When used together with merge fields, Pre-filled data can be used with "send-once" signature requests by adding merge fields with 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 | |
object (SubFieldOptions) This allows the requester to specify field options for a signature request. | |
Array of objects (SubFormFieldGroup) Group information for fields defined in | |
Array of objects (SubFormFieldRule) Conditional Logic rules for fields defined in | |
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.
| |
hide_text_tags | boolean Default: false Send with a value of |
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. | |
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 (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_redirect_url | string The URL you want signers redirected to after they successfully sign. |
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 |
use_preexisting_fields | boolean Default: false Set |
use_text_tags | boolean Default: false Set |
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. |
successful operation
failed_operation
{- "signers": [
- {
- "email_address": "jack@example.com",
- "name": "Jack",
- "order": 0
}
], - "type": "request_signature",
- "test_mode": true
}
{- "unclaimed_draft": {
- "signing_redirect_url": null,
- "expires_at": 1414093891,
- "test_mode": true
}
}