Dropbox Sign Developer Documentation

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.

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.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <username:password>.

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

client_idstringRequired

Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app.

requester_email_addressstringRequiredformat: "email"

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

template_idslist of stringsRequired

Use template_ids to create a SignatureRequest from one or more templates, in the order in which the templates will be used.

allow_declinebooleanOptionalDefaults to false

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

allow_reassignbooleanOptionalDefaults to false

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.

ccslist of objectsOptional

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

custom_fieldslist of objectsOptional

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

editor_optionsobjectOptional

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

field_optionsobjectOptional

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

fileslist of stringsOptional

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.

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_urlslist of stringsOptional

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.

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_rolesbooleanOptionalDefaults to false

Provide users the ability to review/edit the template signer roles.

force_subject_messagebooleanOptionalDefaults to false

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

hold_requestbooleanOptionalDefaults to false

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.

is_for_embedded_signingbooleanOptionalDefaults to false

The request created from this draft will also be signable in embedded mode if set to true. Defaults to false.

messagestringOptional<=5000 characters

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

metadatamap from strings to anyOptional

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.

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_onlybooleanOptionalDefaults to false

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

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

requesting_redirect_urlstringOptional

The URL you want signers redirected to after they successfully request a signature.

show_previewbooleanOptionalDefaults to false

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.

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_stepperbooleanOptionalDefaults to true

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

signerslist of objectsOptional

Add Signers to your Templated-based Signature Request.

signing_optionsobjectOptional

This allows the requester to specify the types allowed for creating a signature.

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

signing_redirect_urlstringOptional

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

skip_me_nowbooleanOptionalDefaults to false

Disables the “Me (Now)” option for the person preparing the document. Does not work with type send_document. Defaults to false.

subjectstringOptional<=255 characters

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

test_modebooleanOptionalDefaults to false

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

titlestringOptional<=255 characters

The title you want to assign to the SignatureRequest.

populate_auto_fill_fieldsbooleanOptionalDefaults to false

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.

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_ccsbooleanOptionalDefaults to false

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

Response headers

X-RateLimit-Limitinteger

The maximum number of requests per hour that you can make.

X-RateLimit-Remaininginteger

The number of requests remaining in the current rate limit window.

X-Ratelimit-Resetinteger

The Unix time at which the rate limit will reset to its maximum.

Response

successful operation

unclaimed_draftobject

A group of documents that a user can take ownership of via the claim URL.

warningslist of objects or null

A list of warnings.

1	import json
2	from datetime import date, datetime
3	from pprint import pprint
4
5	from dropbox_sign import ApiClient, ApiException, Configuration, api, models
6
7	configuration = Configuration(
8	username="YOUR_API_KEY",
9	# access_token="YOUR_ACCESS_TOKEN",
10	)
11
12	with ApiClient(configuration) as api_client:
13	ccs_1 = models.SubCC(
14	role="Accounting",
15	email_address="accounting@dropboxsign.com",
16	)
17
18	ccs = [
19	ccs_1,
20	]
21
22	signers_1 = models.SubUnclaimedDraftTemplateSigner(
23	role="Client",
24	name="George",
25	email_address="george@example.com",
26	)
27
28	signers = [
29	signers_1,
30	]
31
32	unclaimed_draft_create_embedded_with_template_request = models.UnclaimedDraftCreateEmbeddedWithTemplateRequest(
33	client_id="b6b8e7deaf8f0b95c029dca049356d4a2cf9710a",
34	requester_email_address="jack@dropboxsign.com",
35	template_ids=[
36	"61a832ff0d8423f91d503e76bfbcc750f7417c78",
37	],
38	test_mode=False,
39	ccs=ccs,
40	signers=signers,
41	)
42
43	try:
44	response = api.UnclaimedDraftApi(api_client).unclaimed_draft_create_embedded_with_template(
45	unclaimed_draft_create_embedded_with_template_request=unclaimed_draft_create_embedded_with_template_request,
46	)
47
48	pprint(response)
49	except ApiException as e:
50	print("Exception when calling UnclaimedDraftApi#unclaimed_draft_create_embedded_with_template: %s\n" % e)

1	{
2	"unclaimed_draft": {
3	"signature_request_id": "8e55b3880c62497791dda0f3b4181cfd95f7ddb4",
4	"claim_url": "https://embedded.hellosign.com/prep-and-send/embedded-request?cached_params_token=30c4d8df776038c2fa5f7094c3718937",
5	"signing_redirect_url": null,
6	"requesting_redirect_url": null,
7	"test_mode": true
8	}
9	}

Create Embedded Unclaimed Draft with Template

Authentication

Request

Response headers

Response

Errors