Developers
Dropbox Sign DocsGet an API key
HomeAPI ReferenceSDKsContext Plugin
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.

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

allow_decline?boolean

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

Defaultfalse
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.

Defaultfalse
ccs?array<>

Add CC email recipients. Required when a CC role exists for the Template.

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

An array defining values and options for custom fields. Required when a custom field exists in the Template.

editor_options?

This allows the requester to specify editor options when a preparing a document

field_options?

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

files?unknown

Use files[] to append additional files to the signature request being created from the template. Dropbox Sign will parse the files for text tags 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?array<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, 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.

Defaultfalse
force_subject_message?boolean

Provide users the ability to review/edit the template subject and message.

Defaultfalse
hold_request?boolean

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 false.

Defaultfalse
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.

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

Defaultfalse
requester_email_address*string

The email address of the user that should be designated as the requester of this draft.

Formatemail
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.
Defaultfalse
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 Templated-based 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.

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.

Defaultfalse
subject?string

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

Lengthlength <= 255
template_ids*array<string>

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.

Defaultfalse
title?string

The title you want to assign to the SignatureRequest.

Lengthlength <= 255
populate_auto_fill_fields?boolean

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.

Defaultfalse
allow_ccs?boolean

This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft.

Defaultfalse

Response Body

application/json

application/json

curl -X POST "https://example.com/unclaimed_draft/create_embedded_with_template" \  -H "Content-Type: application/json" \  -d '{    "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": {    "claim_url": "https://embedded.hellosign.com/prep-and-send/embedded-request?cached_params_token=30c4d8df776038c2fa5f7094c3718937",    "signature_request_id": "8e55b3880c62497791dda0f3b4181cfd95f7ddb4",    "signing_redirect_url": null,    "requesting_redirect_url": null,    "test_mode": true  }}

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.

Edit and Resend Unclaimed Draft POST

Creates a new signature request from an embedded request that can be edited prior to being sent to the recipients. Parameter `test_mode` can be edited prior to request. Signers can be edited in embedded editor. Requester's email address will remain unchanged if `requester_email_address` parameter is not set. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign.