--- title: "Send with Template" method: POST path: "/signature_request/send_with_template" tags: ["Signature Request"] --- # Send with Template `POST /signature_request/send_with_template` Creates and sends a new SignatureRequest based off of the Template(s) specified with the `template_ids` parameter. ## Request body - SignatureRequestSendWithTemplateRequest - `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. - `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 — Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app. - `custom_fields` SubCustomField[] — An array defining values and options for custom fields. Required when a custom field exists in the 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. - `files` string[] — Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. - `file_urls` string[] — Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. - `is_eid` boolean — Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.
**NOTE:** You need the eID add-on to use this feature. Please [contact sales](https://sign.dropbox.com/form/contact-sales) for more information. Cannot be used in `test_mode`. Only works on requests with one signer. - `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. - `signers` SubSignatureRequestTemplateSigner[], required — Add Signers to your Templated-based Signature Request. - `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). - `signing_options` SubSigningOptions — This allows the requester to specify the types allowed for creating a signature and specify another signing options. **NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings. **NOTE:** If `force_advanced_signature_details` is set, allowed types has to be defined too. - `default_type` 'draw' | 'phone' | 'type' | 'upload', required — The default type shown (limited to the listed types) - `draw` boolean — Allows drawing the signature - `phone` boolean — Allows using a smartphone to email the signature - `type` boolean — Allows typing the signature - `upload` boolean — Allows uploading the signature - `force_advanced_signature_details` boolean — Turning on advanced signature details for the signature request - `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 - SignatureRequestGetResponse - `signature_request` SignatureRequestResponse, required — Contains information about a signature request. - `test_mode` boolean — Whether this is a test signature request. Test requests have no legal value. Defaults to `false`. - `signature_request_id` string — The id of the SignatureRequest. - `requester_email_address` string, nullable — The email address of the initiator of the SignatureRequest. - `title` string — The title the specified Account uses for the SignatureRequest. - `original_title` string — Default Label for account. - `subject` string, nullable — The subject in the email that was initially sent to the signers. - `message` string, nullable — The custom message in the email that was initially sent to the signers. - `metadata` object — The metadata attached to the signature request. - `created_at` integer — Time the signature request was created. - `expires_at` integer, nullable — The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. - `is_complete` boolean — Whether or not the SignatureRequest has been fully executed by all signers. - `is_declined` boolean — Whether or not the SignatureRequest has been declined by a signer. - `has_error` boolean — Whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings). - `files_url` string — The URL where a copy of the request's documents can be downloaded. - `signing_url` string, nullable — The URL where a signer, after authenticating, can sign the documents. This should only be used by users with existing Dropbox Sign accounts as they will be required to log in before signing. - `details_url` string — The URL where the requester and the signers can view the current status of the SignatureRequest. - `cc_email_addresses` string[] — A list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed. - `signing_redirect_url` string, nullable — The URL you want the signer redirected to after they successfully sign. - `final_copy_uri` string, nullable — The path where the completed document can be downloaded - `template_ids` string[], nullable — Templates IDs used in this SignatureRequest (if any). - `custom_fields` SignatureRequestResponseCustomFieldBase[], nullable — An array of Custom Field objects containing the name and type of each custom field. * Text Field uses `SignatureRequestResponseCustomFieldText` * Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` - `type` string, required — The type of this Custom Field. Only 'text' and 'checkbox' are currently supported. - `name` string, required — The name of the Custom Field. - `required` boolean — A boolean value denoting if this field is required. - `api_id` string — The unique ID for this field. - `editor` string, nullable — The name of the Role that is able to edit this field. - `attachments` SignatureRequestResponseAttachment[], nullable — Signer attachments. - `id` string, required — The unique ID for this attachment. - `signer` string, required — The Signer this attachment is assigned to. - `name` string, required — The name of this attachment. - `required` boolean, required — A boolean value denoting if this attachment is required. - `instructions` string, nullable — Instructions for Signer. - `uploaded_at` integer, nullable — Timestamp when attachment was uploaded by Signer. - `response_data` SignatureRequestResponseDataBase[], nullable — An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. - `api_id` string — The unique ID for this field. - `signature_id` string — The ID of the signature to which this response is linked. - `name` string — The name of the form field. - `required` boolean — A boolean value denoting if this field is required. - `type` string - `signatures` SignatureRequestResponseSignatures[] — An array of signature objects, 1 for each signer. - `signature_id` string — Signature identifier. - `signer_group_guid` string, nullable — Signer Group GUID - `signer_email_address` string — The email address of the signer. - `signer_name` string, nullable — The name of the signer. - `signer_role` string, nullable — The role of the signer. - `order` integer, nullable — If signer order is assigned this is the 0-based index for this signer. - `status_code` string — The current status of the signature. eg: awaiting_signature, signed, declined. - `decline_reason` string, nullable — The reason provided by the signer for declining the request. - `signed_at` integer, nullable — Time that the document was signed or null. - `last_viewed_at` integer, nullable — The time that the document was last viewed by this signer or null. - `last_reminded_at` integer, nullable — The time the last reminder email was sent to the signer or null. - `has_pin` boolean — Boolean to indicate whether this signature requires a PIN to access. - `has_sms_auth` boolean, nullable — Boolean to indicate whether this signature has SMS authentication enabled. - `has_sms_delivery` boolean, nullable — Boolean to indicate whether this signature has SMS delivery enabled. - `sms_phone_number` string, nullable — The SMS phone number used for authentication or signature request delivery. - `reassigned_by` string, nullable — Email address of original signer who reassigned to this signer. - `reassignment_reason` string, nullable — Reason provided by original signer who reassigned to this signer. - `reassigned_from` string, nullable — Previous signature identifier. - `error` string, nullable — Error message pertaining to this signer, or null. - `bulk_send_job_id` string, nullable — The ID of the Bulk Send job which sent the signature request, if applicable. - `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)