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.
client_id required | string Client id of the app you're using to create this embedded signature request. Used for security purposes. |
template_ids required | Array of strings Use |
signer_file | string <binary>
Example CSV:
|
Array of objects (SubBulkSignerList)
| |
allow_decline | boolean Default: false Allows signers to decline to sign a document if |
Array of objects (SubCC) Add CC email recipients. Required when a CC role exists for the Template. | |
Array of objects (SubCustomField) When used together with merge fields, Pre-filled data can be used with "send-once" signature requests by adding merge fields with 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 | |
message | string <= 5000 characters The custom message in the email that will be sent to the signers. |
object <= 10 items 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_url | string The URL you want signers redirected to after they successfully sign. |
subject | string <= 255 characters The subject in the email that will be sent to the signers. |
test_mode | boolean Default: false Whether this is a test, the signature request will not be legally binding if set to |
title | string <= 255 characters The title you want to assign to the SignatureRequest. |
successful operation
failed_operation
{- "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
}
}