Skip to content

Latest commit

 

History

History
30 lines (21 loc) · 3.43 KB

SignatureRequestSendWithTemplateRequest.md

File metadata and controls

30 lines (21 loc) · 3.43 KB
Raw

SignatureRequestSendWithTemplateRequest

Properties

Name Type Description Notes
templateIds*required List<String> Use template_ids to create a SignatureRequest from one or more templates, in the order in which the template will be used.
signers*required List<SubSignatureRequestTemplateSigner> Add Signers to your Templated-based Signature Request.
allowDecline Boolean Allows signers to decline to sign a document if true. Defaults to false.
ccs List<SubCC> Add CC email recipients. Required when a CC role exists for the Template.
clientId String Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app.
customFields List<SubCustomField> An array defining values and options for custom fields. Required when a custom field exists in the Template.
files List<File> Use files[] to indicate the uploaded file(s) to send for signature.

This endpoint requires either files or file_urls[], but not both.
fileUrls List<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.
isQualifiedSignature Boolean Send with a value of true if you wish to enable Qualified Electronic Signatures (QES), which requires a face-to-face call to verify the signer's identity.<br>
Note: QES is only available on the Premium API plan as an add-on purchase. Cannot be used in test_mode. Only works on requests with one signer.
isEid Boolean Send with a value of true if you wish to enable electronic identification (eID), which requires the signer to verify their identity with an eID provider to sign a document.<br>
Note: eID is only available on the Premium API plan. 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 Map<String, 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.
signingOptions SubSigningOptions
signingRedirectUrl 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.
testMode 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.