Unclaimed Draft

Create Unclaimed Draft

POST
/unclaimed_draft/create

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.

Authorization

AuthorizationBasic <token>

Your API key can be used to make calls to the Dropbox Sign API. See Authentication for more information. āœ… Supported by Try it console (calls sent in test_mode only).

In: header

Request Body

files?unknown

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<string>

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_decline?boolean

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

Defaultfalse
attachments?array<>

A list describing the attachments

cc_email_addresses?array<>

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.

custom_fields?array<>

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.

field_options?

This allows the requester to specify field options for a signature request.

form_field_groups?array<>

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_rules?array<>

Conditional Logic rules for fields defined in form_fields_per_document.

form_fields_per_document?array<>

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

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.

Defaultfalse
message?string

The custom message in the email that will be sent to the signers.

Lengthlength <= 5000
metadata?

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.

Itemsitems <= 10
show_progress_stepper?boolean

When only one step remains in the signature request process and this parameter is set to false then the progress stepper will be hidden.

Defaulttrue
signers?array<>

Add Signers to your Unclaimed Draft Signature Request.

signing_options?

This allows the requester to specify the types allowed for creating a signature and specify another signing options.

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

NOTE: If force_advanced_signature_details is set, allowed types has to be defined too.

signing_redirect_url?string

The URL you want signers redirected to after they successfully sign.

subject?string

The subject in the email that will be sent to the signers.

Lengthlength <= 200
test_mode?boolean

Whether this is a test, the signature request created from this draft will not be legally binding if set to true. Defaults to false.

Defaultfalse
type*string

The type of unclaimed draft to create. Use send_document to create a claimable file, and request_signature for a claimable signature request. If the type is request_signature then signers name and email_address are not optional.

Value in

  • "send_document"
  • "request_signature"
use_preexisting_fields?boolean

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.

Defaultfalse
use_text_tags?boolean

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.

Defaultfalse
ignore_text_tags_extraction_errors?boolean

Sent with a value of true to ignore the validation errors from text tags extraction. Defaults to false.

Defaultfalse
expires_at?|

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 Body

application/json

application/json

curl -X POST "https://example.com/unclaimed_draft/create" \  -H "Content-Type: application/json" \  -d '{    "file_urls": [      "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1"    ],    "signers": [      {        "email_address": "jack@example.com",        "name": "Jack",        "order": 0      }    ],    "type": "request_signature",    "test_mode": true  }'
{  "unclaimed_draft": {    "claim_url": "https://app.hellosign.com/send/resendDocs?root_snapshot_guids[]=7f967b7d06e154394eab693febedf61e8ebe49eb&amp;snapshot_access_guids[]=fb848631&amp;root_snapshot_guids[]=7aedaf31e12edf9f2672a0b2ddf028aca670e101&amp;snapshot_access_guids[]=f398ef87",    "signing_redirect_url": null,    "expires_at": 1414093891,    "test_mode": true  }}

Update Template Files POST

Overlays a new file with the overlay of an existing template. The new file(s) must: 1. have the same or higher page count 2. the same orientation as the file(s) being replaced. This will not overwrite or in any way affect the existing template. Both the existing template and new template will be available for use after executing this endpoint. Also note that this will decrement your template quota. Overlaying new files is asynchronous and a successful call to this endpoint will return 200 OK response if the request passes initial validation checks. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event will be sent when the files are updated or a `template_error` event will be sent if there was a problem while updating the files. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary. If the page orientation or page count is different from the original template document, we will notify you with a `template_error` [callback event](https://app.hellosign.com/api/eventsAndCallbacksWalkthrough).

Create Embedded Unclaimed Draft POST

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.