---
title: "Create Unclaimed Draft"
method: POST
path: "/unclaimed_draft/create"
tags: ["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.

## Request body

- UnclaimedDraftCreateRequest
  - `files` string[] — 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` 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`.
  - `attachments` SubAttachment[] — A list describing the attachments
    - `instructions` string — The instructions for uploading the attachment.
    - `name` string, required — The name of attachment.
    - `required` boolean — Determines if the attachment must be uploaded.
    - `signer_index` integer, required — The signer's index in the `signers` parameter (0-based indexing). **NOTE:** Only one signer can be assigned per attachment.
  - `cc_email_addresses` string[] — 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` 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](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) 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](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template.
    - `editor` string — Used to create editable merge fields. When the value matches a role passed in with `signers`, that role can edit the data that was pre-filled to that field. This field is optional, but required when this custom field object is set to `required = true`. **NOTE:** Editable merge fields are only supported for single signer requests (or the first signer in ordered signature requests). If used when there are multiple signers in an unordered signature request, the editor value is ignored and the field won't be editable.
    - `name` string, required — The name of a custom field. When working with pre-filled data, the custom field's name must have a matching merge field name or the field will remain empty on the document during signing.
    - `required` boolean — Used to set an editable merge field when working with pre-filled data. When `true`, the custom field must specify a signer role in `editor`.
    - `value` string — The string that resolves (aka "pre-fills") to the merge field on the final document(s) used for signing.
  - `field_options` SubFieldOptions — This allows the requester to specify field options for a signature request.
    - `date_format` 'MM / DD / YYYY' | 'MM - DD - YYYY' | 'DD / MM / YYYY' | 'DD - MM - YYYY' | 'YYYY / MM / DD' | 'YYYY - MM - DD', required — Allows requester to specify the date format (see list of allowed [formats](/api/reference/constants/#date-formats)) **NOTE:** Only available for Premium and higher.
  - `form_field_groups` 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`.
    - `group_id` string, required — ID of group. Use this to reference a specific group from the `group` value in `form_fields_per_document`.
    - `group_label` string, required — Name of the group
    - `requirement` string, required — Examples: `require_0-1` `require_1` `require_1-ormore` - Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group.
  - `form_field_rules` SubFormFieldRule[] — Conditional Logic rules for fields defined in `form_fields_per_document`.
    - `id` string, required — Must be unique across all defined rules.
    - `trigger_operator` string, required — Currently only `AND` is supported. Support for `OR` is being worked on.
    - `triggers` SubFormFieldRuleTrigger[], required — An array of trigger definitions, the "if this" part of "**if this**, then that". Currently only a single trigger per rule is allowed.
      - `id` string, required — Must reference the `api_id` of an existing field defined within `form_fields_per_document`. Trigger and action fields and groups must belong to the same signer.
      - `operator` 'any' | 'is' | 'match' | 'none' | 'not', required — Different field types allow different `operator` values: - Field type of **text**: - **is**: exact match - **not**: not exact match - **match**: regular expression, without /. Example: - OK `[a-zA-Z0-9]` - Not OK `/[a-zA-Z0-9]/` - Field type of **dropdown**: - **is**: exact match, single value - **not**: not exact match, single value - **any**: exact match, array of values. - **none**: not exact match, array of values. - Field type of **checkbox**: - **is**: exact match, single value - **not**: not exact match, single value - Field type of **radio**: - **is**: exact match, single value - **not**: not exact match, single value
      - `value` string — **value** or **values** is required, but not both. The value to match against **operator**. - When **operator** is one of the following, **value** must be `String`: - `is` - `not` - `match` Otherwise, - **checkbox**: When **type** of trigger is **checkbox**, **value** must be `0` or `1` - **radio**: When **type** of trigger is **radio**, **value** must be `1`
      - `values` string[] — **values** or **value** is required, but not both. The values to match against **operator** when it is one of the following: - `any` - `none`
    - `actions` SubFormFieldRuleAction[], required — An array of action definitions, the "then that" part of "if this, **then that**". Any number of actions may be attached to a single rule.
      - `field_id` string — **field_id** or **group_id** is required, but not both. Must reference the `api_id` of an existing field defined within `form_fields_per_document`. Cannot use with `group_id`. Trigger and action fields must belong to the same signer.
      - `group_id` string — **group_id** or **field_id** is required, but not both. Must reference the ID of an existing group defined within `form_field_groups`. Cannot use with `field_id`. Trigger and action fields and groups must belong to the same signer.
      - `hidden` boolean, required — `true` to hide the target field when rule is satisfied, otherwise `false`.
      - `type` 'change-field-visibility' | 'change-group-visibility', required
  - `form_fields_per_document` 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](/docs/openapi/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](/api/reference/constants/#form-fields-per-document) 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`
    - `document_index` integer, required — Represents the integer index of the `file` or `file_url` document the field should be attached to.
    - `api_id` string, required — An identifier for the field that is unique across all documents in the request.
    - `height` integer, required — Size of the field in pixels.
    - `name` string — Display name for the field.
    - `page` integer, nullable — Page in the document where the field should be placed (requires documents be PDF files). - When the page number parameter is supplied, the API will use the new coordinate system. - Check out the differences between both [coordinate systems](https://faq.hellosign.com/hc/en-us/articles/217115577) and how to use them.
    - `required` boolean, required — Whether this field is required.
    - `signer` string, required — Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field. **NOTE:** To set the value of the field as the preparer you must set this to `me_now` **NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data.
    - `type` string, required
    - `width` integer, required — Size of the field in pixels.
    - `x` integer, required — Location coordinates of the field in pixels.
    - `y` integer, required — Location coordinates of the field in pixels.
  - `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](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) walkthrough for more details.
  - `message` string — The custom message in the email that will be sent to the signers.
  - `metadata` object — 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 — When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden.
  - `signers` SubUnclaimedDraftSigner[] — Add Signers to your Unclaimed Draft Signature Request.
    - `email_address` string, email, required — The email address of the signer.
    - `name` string, required — The name of the signer.
    - `order` integer, nullable — The order the signer is required to sign in.
  - `signing_options` SubSigningOptions — 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.
    - `default_type` 'draw' | 'phone' | 'type' | 'upload', required — The default type shown (limited to the listed types)
    - `draw` boolean — Allows drawing the signature
    - `phone` boolean — Allows using a smartphone to email the signature
    - `type` boolean — Allows typing the signature
    - `upload` boolean — Allows uploading the signature
    - `force_advanced_signature_details` boolean — Turning on advanced signature details for the signature request
  - `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.
  - `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`.
  - `type` 'send_document' | 'request_signature', required — 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.
  - `use_preexisting_fields` boolean — Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) 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 — Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) 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.
  - `expires_at` integer, nullable — When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. **NOTE:** This does not correspond to the **expires_at** returned in the response.

## Response `200`

successful operation

- UnclaimedDraftCreateResponse
  - `unclaimed_draft` UnclaimedDraftResponse, required — A group of documents that a user can take ownership of via the claim URL.
    - `signature_request_id` string, nullable — The ID of the signature request that is represented by this UnclaimedDraft.
    - `claim_url` string — The URL to be used to claim this UnclaimedDraft.
    - `signing_redirect_url` string, nullable — The URL you want signers redirected to after they successfully sign.
    - `requesting_redirect_url` string, nullable — The URL you want signers redirected to after they successfully request a signature (Will only be returned in the response if it is applicable to the request.).
    - `expires_at` integer, nullable — When the link expires.
    - `test_mode` boolean — Whether this is a test draft. Signature requests made from test drafts have no legal value.
  - `warnings` WarningResponse[] — A list of warnings.
    - `warning_msg` string, required — Warning message
    - `warning_name` string, required — Warning name

## Other responses

- `4XX` — failed_operation

---

[API](https://skmtc.net/hellosign/apis/dropbox-sign-api.md) · [All operations](https://skmtc.net/hellosign/apis/dropbox-sign-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hellosign/dropbox-sign-api/revisions/7535b8f1a188/schema)