Sign in

v1

latestOpenAPI 3.0.3MIT2026-07-1373217576.0 KB
Signature Request

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.

post/signature_request/bulk_create_embedded_with_template

Request body

template_idsstring[] required

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

signer_filestring 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
allow_declineboolean

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

client_idstring required

Client id of the app you're using to create this embedded signature request. Used for security purposes.

messagestring

The custom message in the email that will be sent to the signers.

metadataobject

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_urlstring

The URL you want signers redirected to after they successfully sign.

subjectstring

The subject in the email that will be sent to the signers.

test_modeboolean

Whether this is a test, the signature request will not be legally binding if set to true. Defaults to false.

titlestring

The title you want to assign to the SignatureRequest.

Response

successful operation