Dropbox Sign Developer Documentation

Creates and sends a new SignatureRequest based off of the Template(s) specified with the template_ids parameter.

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.

template_idslist of stringsRequired

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

signerslist of objectsRequired

Add Signers to your Templated-based Signature Request.

allow_declinebooleanOptionalDefaults to false

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

ccslist of objectsOptional

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

client_idstringOptional

Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app.

custom_fieldslist of objectsOptional

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

fileslist of stringsOptional

Use files[] to indicate the uploaded file(s) to send for signature.

This endpoint requires either files or file_urls[], but not both.

file_urlslist of stringsOptional

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.

is_eidbooleanOptionalDefaults to false

Send with a value of true if you wish to enable electronic identification (eID), which requires the signer to verify their identity with an eID provider to sign a document.
NOTE: eID is only available on the Premium API plan. Cannot be used in test_mode. Only works on requests with one signer.

Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br> **NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer.

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.

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.

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 will not be legally binding if set to true. Defaults to false.

titlestringOptional<=255 characters

The title you want to assign to the SignatureRequest.

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

signature_requestobject

Contains information about a signature request.

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	signing_options = models.SubSigningOptions(
14	default_type="draw",
15	draw=True,
16	phone=False,
17	type=True,
18	upload=True,
19	)
20
21	signers_1 = models.SubSignatureRequestTemplateSigner(
22	role="Client",
23	name="George",
24	email_address="george@example.com",
25	)
26
27	signers = [
28	signers_1,
29	]
30
31	ccs_1 = models.SubCC(
32	role="Accounting",
33	email_address="accounting@example.com",
34	)
35
36	ccs = [
37	ccs_1,
38	]
39
40	custom_fields_1 = models.SubCustomField(
41	name="Cost",
42	editor="Client",
43	required=True,
44	value="$20,000",
45	)
46
47	custom_fields = [
48	custom_fields_1,
49	]
50
51	signature_request_send_with_template_request = models.SignatureRequestSendWithTemplateRequest(
52	template_ids=[
53	"61a832ff0d8423f91d503e76bfbcc750f7417c78",
54	],
55	message="Glad we could come to an agreement.",
56	subject="Purchase Order",
57	test_mode=True,
58	signing_options=signing_options,
59	signers=signers,
60	ccs=ccs,
61	custom_fields=custom_fields,
62	)
63
64	try:
65	response = api.SignatureRequestApi(api_client).signature_request_send_with_template(
66	signature_request_send_with_template_request=signature_request_send_with_template_request,
67	)
68
69	pprint(response)
70	except ApiException as e:
71	print("Exception when calling SignatureRequestApi#signature_request_send_with_template: %s\n" % e)

1	{
2	"signature_request": {
3	"signature_request_id": "17d163069282df5eb63857d31ff4a3bffa9e46c0",
4	"requester_email_address": "me@dropboxsign.com",
5	"title": "Purchase Order",
6	"original_title": "Purchase Order",
7	"subject": "Purchase Order",
8	"message": "Glad we could come to an agreement.",
9	"metadata": {},
10	"created_at": 1570471067,
11	"is_complete": false,
12	"is_declined": false,
13	"has_error": false,
14	"signing_url": "https://app.hellosign.com/sign/17d163069282df5eb63857d31ff4a3bffa9e46c0",
15	"details_url": "https://app.hellosign.com/home/manage?guid=17d163069282df5eb63857d31ff4a3bffa9e46c0",
16	"cc_email_addresses": [
17	"accounting@dropboxsign.com"
18	],
19	"signing_redirect_url": null,
20	"custom_fields": [
21	{
22	"type": "text",
23	"name": "Cost",
24	"editor": "Client",
25	"required": true
26	}
27	],
28	"response_data": [],
29	"signatures": [
30	{
31	"signature_id": "10ab1cd037d9b6cba7975d61ff428c8d",
32	"signer_email_address": "george@example.com",
33	"signer_name": "George",
34	"signer_role": "Client",
35	"order": null,
36	"status_code": "awaiting_signature",
37	"signed_at": null,
38	"last_viewed_at": null,
39	"last_reminded_at": null,
40	"has_pin": false,
41	"has_sms_auth": false
42	}
43	]
44	}
45	}

Send with Template

Authentication

Request

Response headers

Response

Errors