Dropbox Sign Developer Documentation

Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the template_ids parameter.

NOTE: Only available for Standard plan and higher.

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.

signer_filestringOptionalformat: "binary"

signer_file is a CSV file defining values and options for signer fields. Required unless a signer_list is used, you may not use both. The CSV can have the following columns:

name: the name of the signer filling the role of RoleName
email_address: email address of the signer filling the role of RoleName
pin: the 4- to 12-character access code that will secure this signer’s signature page (optional)
sms_phone_number: An E.164 formatted phone number that will receive a code via SMS to access this signer’s signature page. (optional)

By using the feature, you agree you are responsible for obtaining a signer’s consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. Learn more.

NOTE: Not available in test mode and requires a Standard plan or higher.
*_field: any column with a _field” suffix will be treated as a custom field (optional)

You may only specify field values here, any other options should be set in the custom_fields request parameter.

Example CSV:

name, email_address, pin, company_field
George, george@example.com, d79a3td, ABC Corp
Mary, mary@example.com, gd9as5b, 123 LLC

`signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns: - `name`: the name of the signer filling the role of RoleName - `email_address`: email address of the signer filling the role of RoleName - `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional) - `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional) By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on). **NOTE:** Not available in test mode and requires a Standard plan or higher. - `*_field`: any column with a _field" suffix will be treated as a custom field (optional) You may only specify field values here, any other options should be set in the custom_fields request parameter. Example CSV: ``` name, email_address, pin, company_field George, george@example.com, d79a3td, ABC Corp Mary, mary@example.com, gd9as5b, 123 LLC ```

signer_listlist of objectsOptional

signer_list is an array defining values and options for signer fields. Required unless a signer_file is used, you may not use both.

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

The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app.

custom_fieldslist of objectsOptional

When used together with merge fields, custom_fields allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with “send-once” signature requests by adding merge fields with form_fields_per_document or Text Tags while passing values back with custom_fields together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling /template/create_embedded_draft and then passing custom_fields on subsequent signature requests referencing that template.

When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template.

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

bulk_send_jobobject

Contains information about the BulkSendJob such as when it was created and how many signature requests are queued.

warningslist of objects or null

A list of warnings.

Errors

signer_file is a CSV file defining values and options for signer fields. Required unless a signer_list is used, you may not use both. The CSV can have the following columns:

name: the name of the signer filling the role of RoleName
email_address: email address of the signer filling the role of RoleName
pin: the 4- to 12-character access code that will secure this signer’s signature page (optional)
sms_phone_number: An E.164 formatted phone number that will receive a code via SMS to access this signer’s signature page. (optional)

By using the feature, you agree you are responsible for obtaining a signer’s consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. Learn more.

NOTE: Not available in test mode and requires a Standard plan or higher.
*_field: any column with a _field” suffix will be treated as a custom field (optional)

You may only specify field values here, any other options should be set in the custom_fields request parameter.

Example CSV:

name, email_address, pin, company_field
George, george@example.com, d79a3td, ABC Corp
Mary, mary@example.com, gd9as5b, 123 LLC

1	import * as fs from 'fs';
2	import api from "@dropbox/sign"
3	import models from "@dropbox/sign"
4
5	const apiCaller = new api.SignatureRequestApi();
6	apiCaller.username = "YOUR_API_KEY";
7	// apiCaller.accessToken = "YOUR_ACCESS_TOKEN";
8
9	const signerList2CustomFields1: models.SubBulkSignerListCustomField = {
10	name: "company",
11	value: "123 LLC",
12	};
13
14	const signerList2CustomFields = [
15	signerList2CustomFields1,
16	];
17
18	const signerList2Signers1: models.SubSignatureRequestTemplateSigner = {
19	role: "Client",
20	name: "Mary",
21	emailAddress: "mary@example.com",
22	pin: "gd9as5b",
23	};
24
25	const signerList2Signers = [
26	signerList2Signers1,
27	];
28
29	const signerList1CustomFields1: models.SubBulkSignerListCustomField = {
30	name: "company",
31	value: "ABC Corp",
32	};
33
34	const signerList1CustomFields = [
35	signerList1CustomFields1,
36	];
37
38	const signerList1Signers1: models.SubSignatureRequestTemplateSigner = {
39	role: "Client",
40	name: "George",
41	emailAddress: "george@example.com",
42	pin: "d79a3td",
43	};
44
45	const signerList1Signers = [
46	signerList1Signers1,
47	];
48
49	const signerList1: models.SubBulkSignerList = {
50	customFields: signerList1CustomFields,
51	signers: signerList1Signers,
52	};
53
54	const signerList2: models.SubBulkSignerList = {
55	customFields: signerList2CustomFields,
56	signers: signerList2Signers,
57	};
58
59	const signerList = [
60	signerList1,
61	signerList2,
62	];
63
64	const ccs1: models.SubCC = {
65	role: "Accounting",
66	emailAddress: "accounting@example.com",
67	};
68
69	const ccs = [
70	ccs1,
71	];
72
73	const signatureRequestBulkSendWithTemplateRequest: models.SignatureRequestBulkSendWithTemplateRequest = {
74	templateIds: [
75	"c26b8a16784a872da37ea946b9ddec7c1e11dff6",
76	],
77	message: "Glad we could come to an agreement.",
78	subject: "Purchase Order",
79	testMode: true,
80	signerList: signerList,
81	ccs: ccs,
82	};
83
84	apiCaller.signatureRequestBulkSendWithTemplate(
85	signatureRequestBulkSendWithTemplateRequest,
86	).then(response => {
87	console.log(response.body);
88	}).catch(error => {
89	console.log("Exception when calling SignatureRequestApi#signatureRequestBulkSendWithTemplate:");
90	console.log(error.body);
91	});

1	{
2	"bulk_send_job": {
3	"bulk_send_job_id": "4bce667844dc3711d05e7aa4a1b5a6b64b738b2b",
4	"total": 1,
5	"is_creator": true,
6	"created_at": 1532640962
7	}
8	}