Dropbox Sign/signatureRequestBulkCreateEmbeddedWithTemplate

Preview only · details below

Dropbox SignDropbox Sign eSignature API

POST/signature_request/bulk_create_embedded_with_template

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.

Manage accounts, signature requests, templates, teams, bulk sends, file downloads, fax, and event callbacks through the complete Dropbox Sign v3 API; the Hub provides documentation and a local SDK/CLI only.

Request

operationId
signatureRequestBulkCreateEmbeddedWithTemplate
Server
https://api.hellosign.com/v3
Authentication
api_key, oauth2

Request parameters

No URL, query, or header parameters.

Request body

SignatureRequestBulkCreateEmbeddedWithTemplateRequestrequired

Content-Type: application/json, multipart/form-data

Properties: template_idssigner_filesigner_listallow_declineccsclient_idcustom_fieldsmessagemetadatasigning_redirect_urlsubjecttest_modetitle

{
  "template_ids": [
    {}
  ],
  "signer_list": [
    {
      "custom_fields": [
        {
          "name": "Example Name"
        }
      ],
      "signers": [
        {
          "name": "Example Name",
          "email_address": "developer@example.com",
          "sms_phone_number": "+12025550123",
          "sms_phone_number_type": "authentication"
        }
      ]
    }
  ],
  "allow_decline": false,
  "ccs": [
    {
      "email_address": "developer@example.com"
    }
  ],
  "client_id": "example-client-id",
  "custom_fields": [
    {
      "name": "Example Name",
      "required": false
    }
  ],
  "message": "Example message"
}

Responses

200

BulkSendJobSendResponseapplication/json

successful operation

Properties: bulk_send_jobwarnings

4XX

ErrorResponseapplication/json

failed_operation

Properties: error

{
  "bulk_send_job": {
    "bulk_send_job_id": "example-bulk-send-job-id",
    "total": 0,
    "is_creator": false,
    "created_at": 0
  },
  "warnings": [
    {
      "warning_name": "Example Name"
    }
  ]
}