Embedded Bulk Send with Template
Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the template_ids parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
NOTE: Only available for Standard plan and higher.
Authorization
api_key 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
Use template_ids to create a SignatureRequest from one or more templates, in the order in which the template will be used.
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_fieldGeorge, george@example.com, d79a3td, ABC CorpMary, mary@example.com, gd9as5b, 123 LLCsigner_list is an array defining values and options for signer fields. Required unless a signer_file is used, you may not use both.
Allows signers to decline to sign a document if true. Defaults to false.
falseAdd CC email recipients. Required when a CC role exists for the Template.
Client id of the app you're using to create this embedded signature request. Used for security purposes.
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.
The custom message in the email that will be sent to the signers.
length <= 5000Key-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.
items <= 10The URL you want signers redirected to after they successfully sign.
The subject in the email that will be sent to the signers.
length <= 255Whether this is a test, the signature request will not be legally binding if set to true. Defaults to false.
falseThe title you want to assign to the SignatureRequest.
length <= 255When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See Signature Request Expiration Date for details.
Response Body
application/json
application/json
curl -X POST "https://example.com/signature_request/bulk_create_embedded_with_template" \ -H "Content-Type: application/json" \ -d '{ "client_id": "1a659d9ad95bccd307ecad78d72192f8", "template_ids": [ "c26b8a16784a872da37ea946b9ddec7c1e11dff6" ], "subject": "Purchase Order", "message": "Glad we could come to an agreement.", "signer_list": [ { "signers": [ { "role": "Client", "name": "George", "email_address": "george@example.com", "pin": "d79a3td" } ], "custom_fields": [ { "name": "company", "value": "ABC Corp" } ] }, { "signers": [ { "role": "Client", "name": "Mary", "email_address": "mary@example.com", "pin": "gd9as5b" } ], "custom_fields": [ { "name": "company", "value": "123 LLC" } ] } ], "ccs": [ { "role": "Accounting", "email_address": "accounting@example.com" } ], "test_mode": true }'{ "bulk_send_job": { "bulk_send_job_id": "ccaf88244ef006b6e31ebba5ed4cb53b3131d9ac", "total": 3, "is_creator": true, "created_at": 1543556038 }}Create Report POST
Request the creation of one or more report(s). When the report(s) have been generated, you will receive an email (one per requested report type) containing a link to download the report as a CSV file. The requested date range may be up to 12 months in duration, and `start_date` must not be more than 10 years in the past.
Bulk Send with Template POST
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.