Name | Type | Description | Notes |
---|---|---|---|
templateIds *required |
Array<string> |
Use template_ids to create a SignatureRequest from one or more templates, in the order in which the template will be used. |
|
clientId *required |
string |
Client id of the app you're using to create this embedded signature request. Used for security purposes. | |
signers *required |
Array<SubSignatureRequestTemplateSigner> |
Add Signers to your Templated-based Signature Request. | |
allowDecline |
boolean |
Allows signers to decline to sign a document if true . Defaults to false . |
[default to false] |
ccs |
Array<SubCC> |
Add CC email recipients. Required when a CC role exists for the Template. | |
customFields |
Array<SubCustomField> |
An array defining values and options for custom fields. Required when a custom field exists in the Template. | |
files |
Array<RequestFile> |
Use files[] to indicate the uploaded file(s) to send for signature.This endpoint requires either files or file_urls[], but not both. |
|
fileUrls |
Array<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. |
|
message |
string |
The custom message in the email that will be sent to the signers. | |
metadata |
{ [key: string]: any; } |
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. |
|
signingOptions |
SubSigningOptions |
||
subject |
string |
The subject in the email that will be sent to the signers. | |
testMode |
boolean |
Whether this is a test, the signature request will not be legally binding if set to true . Defaults to false . |
[default to false] |
title |
string |
The title you want to assign to the SignatureRequest. | |
populateAutoFillFields |
boolean |
Controls whether auto fill fields can automatically populate a signer's information during signing. NOTE: Keep your signer's information safe by ensuring that the signer on your signature request is the intended party before using this feature. |
[default to false] |