---
title: "Embedded Bulk Send with Template"
method: POST
path: "/signature_request/bulk_create_embedded_with_template"
tags: ["Signature Request"]
---

# Embedded Bulk Send with Template

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

## Request body

- SignatureRequestBulkCreateEmbeddedWithTemplateRequest
  - `template_ids` string[], required — Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used.
  - `signer_file` string, 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](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on). **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 ```
  - `signer_list` SubBulkSignerList[] — `signer_list` is an array defining values and options for signer fields. Required unless a `signer_file` is used, you may not use both.
    - `custom_fields` SubBulkSignerListCustomField[] — An array of custom field values.
      - `name` string, required — The name of the custom field. Must be the field's `name` or `api_id`.
      - `value` string, required — The value of the custom field.
    - `signers` SubSignatureRequestTemplateSigner[] — Add Signers to your Templated-based Signature Request. Allows the requester to specify editor options when a preparing a document. Currently only templates with a single role are supported. All signers must have the same `role` value.
      - `role` string, required — Must match an existing role in chosen Template(s). It's case-sensitive.
      - `name` string, required — The name of the signer.
      - `email_address` string, email, required — The email address of the signer.
      - `pin` string — The 4- to 12-character access code that will secure this signer's signature page.
      - `sms_phone_number` string — An E.164 formatted phone number. 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](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on). **NOTE:** Not available in test mode and requires a Standard plan or higher.
      - `sms_phone_number_type` 'authentication' | 'delivery' — Specifies the feature used with the `sms_phone_number`. Default `authentication`. If `authentication`, signer is sent a verification code via SMS that is required to access the document. If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email).
  - `allow_decline` boolean — Allows signers to decline to sign a document if `true`. Defaults to `false`.
  - `ccs` SubCC[] — Add CC email recipients. Required when a CC role exists for the Template.
    - `role` string, required — Must match an existing CC role in chosen Template(s). Multiple CC recipients cannot share the same CC role.
    - `email_address` string, email, required — The email address of the CC recipient.
  - `client_id` string, required — Client id of the app you're using to create this embedded signature request. Used for security purposes.
  - `custom_fields` SubCustomField[] — 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](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) 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](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template.
    - `editor` string — Used to create editable merge fields. When the value matches a role passed in with `signers`, that role can edit the data that was pre-filled to that field. This field is optional, but required when this custom field object is set to `required = true`. **NOTE:** Editable merge fields are only supported for single signer requests (or the first signer in ordered signature requests). If used when there are multiple signers in an unordered signature request, the editor value is ignored and the field won't be editable.
    - `name` string, required — The name of a custom field. When working with pre-filled data, the custom field's name must have a matching merge field name or the field will remain empty on the document during signing.
    - `required` boolean — Used to set an editable merge field when working with pre-filled data. When `true`, the custom field must specify a signer role in `editor`.
    - `value` string — The string that resolves (aka "pre-fills") to the merge field on the final document(s) used for signing.
  - `message` string — The custom message in the email that will be sent to the signers.
  - `metadata` object — 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 — The subject in the email that will be sent to the signers.
  - `test_mode` boolean — Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.
  - `title` string — The title you want to assign to the SignatureRequest.

## Response `200`

successful operation

- BulkSendJobSendResponse
  - `bulk_send_job` BulkSendJobResponse, required — Contains information about the BulkSendJob such as when it was created and how many signature requests are queued.
    - `bulk_send_job_id` string, nullable — The id of the BulkSendJob.
    - `total` integer — The total amount of Signature Requests queued for sending.
    - `is_creator` boolean — True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member.
    - `created_at` integer — Time that the BulkSendJob was created.
  - `warnings` WarningResponse[] — A list of warnings.
    - `warning_msg` string, required — Warning message
    - `warning_name` string, required — Warning name

## Other responses

- `4XX` — failed_operation

---

[API](https://skmtc.net/hellosign/apis/dropbox-sign-api.md) · [All operations](https://skmtc.net/hellosign/apis/dropbox-sign-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hellosign/dropbox-sign-api/versions/2ea3f04008af/schema)