OPENAPI / COMPONENTS / SCHEMAS
Signature Request Send With Template Request
SignatureRequestSendWithTemplateRequestCreates and sends a new SignatureRequest based off of the Template(s) specified with the `template_ids` parameter.
template_idsarrayrequiredUse `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used.
allow_declinebooleanAllows signers to decline to sign a document if `true`. Defaults to `false`.
ccsSubCCAdd CC email recipients. Required when a CC role exists for the Template.
client_idstringClient id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app.
custom_fieldsSubCustomFieldAn array defining values and options for custom fields. Required when a custom field exists in the Template.
filesarrayUse `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.
file_urlsarrayUse `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_eidbooleanSend with a value of `true` if you wish to enable [electronic identification (eID)](https://sign.dropbox.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br> **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.
messagestringThe custom message in the email that will be sent to the signers.
metadataobjectKey-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.
signersSubSignatureRequestTemplateSignerrequiredAdd Signers to your Templated-based Signature Request.
signing_optionsSubSigningOptionssigning_redirect_urlstringThe URL you want signers redirected to after they successfully sign.
subjectstringThe subject in the email that will be sent to the signers.
test_modebooleanWhether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.
titlestringThe title you want to assign to the SignatureRequest.