Signature Request

Bulk Send with Template

POST
/signature_request/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.

NOTE: Only available for Standard plan and higher.

Authorization

AuthorizationBasic <token>

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

Request Body

template_ids*array<string>

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

signer_file?unknown

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 LLC
signer_list?array<>

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_decline?boolean

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

Defaultfalse
ccs?array<>

Add CC email recipients. Required when a CC role exists for the Template.

client_id?string

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_fields?array<>

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.

message?string

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

Lengthlength <= 5000
metadata?

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.

Itemsitems <= 10
signing_redirect_url?string

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

subject?string

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

Lengthlength <= 255
test_mode?boolean

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

Defaultfalse
title?string

The title you want to assign to the SignatureRequest.

Lengthlength <= 255
expires_at?|

When 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_send_with_template" \  -H "Content-Type: application/json" \  -d '{    "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": "4bce667844dc3711d05e7aa4a1b5a6b64b738b2b",    "total": 1,    "is_creator": true,    "created_at": 1532640962  }}

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

Cancel Incomplete Signature Request POST

Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](https://developers.hellosign.com/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`.