---
title: "Create Embedded Unclaimed Draft with Template"
method: POST
path: "/unclaimed_draft/create_embedded_with_template"
tags: ["Unclaimed Draft"]
---

# Create Embedded Unclaimed Draft with Template

`POST /unclaimed_draft/create_embedded_with_template`

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.

## Request body

- UnclaimedDraftCreateEmbeddedWithTemplateRequest
  - `allow_decline` boolean — Allows signers to decline to sign a document if `true`. Defaults to `false`.
  - `allow_reassign` boolean — 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.
  - `ccs` SubCC[] — Add CC email recipients. Required when a CC role exists for the Template.
    - `role` string, required — Must match an existing CC role in chosen Template(s). Multiple CC recipients cannot share the same CC role.
    - `email_address` string, email, required — The email address of the CC recipient.
  - `client_id` string, required — 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[] — An array defining values and options for custom fields. Required when a custom field exists in the 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.
  - `editor_options` SubEditorOptions — This allows the requester to specify editor options when a preparing a document
    - `allow_edit_signers` boolean — Allows requesters to edit the list of signers
    - `allow_edit_documents` boolean — Allows requesters to edit documents, including delete and add
  - `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.
  - `files` string[] — Use `files[]` to append additional files to the signature request being created from the template. Dropbox Sign will parse the files for [text tags](https://app.hellosign.com/api/textTagsWalkthrough) and append it 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.
  - `file_urls` string[] — 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](https://app.hellosign.com/api/textTagsWalkthrough), 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 — Provide users the ability to review/edit the template signer roles.
  - `force_subject_message` boolean — Provide users the ability to review/edit the template subject and message.
  - `hold_request` boolean — The request from this draft will not automatically send to signers post-claim if set to 1. Requester must [release](/api/reference/operation/signatureRequestReleaseHold/) the request from hold when ready to send. Defaults to `false`.
  - `is_for_embedded_signing` boolean — The request created from this draft will also be signable in embedded mode if set to `true`. Defaults to `false`.
  - `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.
  - `preview_only` boolean — 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). - `preview_only=true`: Allows requesters to enable the preview only experience. - `preview_only=false`: Allows requesters to disable the preview only experience. **NOTE:** This parameter overwrites `show_preview=1` (if set).
  - `requester_email_address` string, email, required — The email address of the user that should be designated as the requester of this draft.
  - `requesting_redirect_url` string — The URL you want signers redirected to after they successfully request a signature.
  - `show_preview` boolean — 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.
  - `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` SubUnclaimedDraftTemplateSigner[] — Add Signers to your Templated-based Signature Request.
    - `role` string, required — Must match an existing role in chosen Template(s).
    - `name` string, required — The name of the signer filling the role of `role`.
    - `email_address` string, email, required — The email address of the signer filling the role of `role`.
  - `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.
  - `skip_me_now` boolean — Disables the "Me (Now)" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`.
  - `subject` string — The subject in the email that will be sent to the signers.
  - `template_ids` string[], required — Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the templates will be used.
  - `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`.
  - `title` string — The title you want to assign to the SignatureRequest.
  - `populate_auto_fill_fields` boolean — Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-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 — This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft.

## 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)