Dropbox Sign Developer Documentation

Creates a template that can then be used.

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.

form_fields_per_documentlist of objectsRequired

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

NOTE: Fields like text, dropdown, checkbox, radio, and hyperlink have additional required and optional parameters. Check out the list of additional parameters 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

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`

signer_roleslist of objectsRequired

An array of the designated signer roles that must be specified when sending a SignatureRequest using this 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.

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.

attachmentslist of objectsOptional

A list describing the attachments

cc_roleslist of stringsOptional

The CC roles that must be assigned when using the template to send a signature request

client_idstringOptional

Client id of the app you're using to create this draft. Used to apply the branding and callback url defined for the app.

field_optionsobjectOptional

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

form_field_groupslist of objectsOptional

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.

form_field_ruleslist of objectsOptional

Conditional Logic rules for fields defined in form_fields_per_document.

merge_fieldslist of objectsOptional

Add merge fields to the template. Merge fields are placed by the user creating the template and used to pre-fill data by passing values into signature requests with the custom_fields parameter. If the signature request using that template does not pass a value into a merge field, then an empty field remains in the document.

messagestringOptional<=5000 characters

The default template email message.

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.

subjectstringOptional<=200 characters

The template title (alias).

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

The title you want to assign to the SignatureRequest.

use_preexisting_fieldsbooleanOptionalDefaults to false

Enable the detection of predefined PDF fields by setting the use_preexisting_fields to true (defaults to disabled, or false).

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

templateobject

Template object with parameters: template_id.

warningslist of objects or null

A list of warnings.

Errors

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

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

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	field_options = models.SubFieldOptions(
14	date_format="DD - MM - YYYY",
15	)
16
17	signer_roles_1 = models.SubTemplateRole(
18	name="Client",
19	order=0,
20	)
21
22	signer_roles_2 = models.SubTemplateRole(
23	name="Witness",
24	order=1,
25	)
26
27	signer_roles = [
28	signer_roles_1,
29	signer_roles_2,
30	]
31
32	form_fields_per_document_1 = models.SubFormFieldsPerDocumentText(
33	document_index=0,
34	api_id="uniqueIdHere_1",
35	type="text",
36	required=True,
37	signer="1",
38	width=100,
39	height=16,
40	x=112,
41	y=328,
42	name="",
43	page=1,
44	placeholder="",
45	validation_type="numbers_only",
46	)
47
48	form_fields_per_document_2 = models.SubFormFieldsPerDocumentSignature(
49	document_index=0,
50	api_id="uniqueIdHere_2",
51	type="signature",
52	required=True,
53	signer="0",
54	width=120,
55	height=30,
56	x=530,
57	y=415,
58	name="",
59	page=1,
60	)
61
62	form_fields_per_document = [
63	form_fields_per_document_1,
64	form_fields_per_document_2,
65	]
66
67	merge_fields_1 = models.SubMergeField(
68	name="Full Name",
69	type="text",
70	)
71
72	merge_fields_2 = models.SubMergeField(
73	name="Is Registered?",
74	type="checkbox",
75	)
76
77	merge_fields = [
78	merge_fields_1,
79	merge_fields_2,
80	]
81
82	template_create_request = models.TemplateCreateRequest(
83	client_id="37dee8d8440c66d54cfa05d92c160882",
84	message="For your approval",
85	subject="Please sign this document",
86	test_mode=True,
87	title="Test Template",
88	cc_roles=[
89	"Manager",
90	],
91	files=[
92	open("./example_signature_request.pdf", "rb").read(),
93	],
94	field_options=field_options,
95	signer_roles=signer_roles,
96	form_fields_per_document=form_fields_per_document,
97	merge_fields=merge_fields,
98	)
99
100	try:
101	response = api.TemplateApi(api_client).template_create(
102	template_create_request=template_create_request,
103	)
104
105	pprint(response)
106	except ApiException as e:
107	print("Exception when calling TemplateApi#template_create: %s\n" % e)

1	{
2	"template": {
3	"template_id": "f57db65d3f933b5316d398057a36176831451a35"
4	}
5	}