OPENAPI / COMPONENTS / SCHEMAS

Signature Request Edit Embedded With Template Request

SignatureRequestEditEmbeddedWithTemplateRequest

SignatureRequestEditEmbeddedWithTemplateRequest data structure

object15properties
template_idsarrayrequired

Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used.

allow_declineboolean

Allows signers to decline to sign a document if `true`. Defaults to `false`.

ccsSubCC

Add CC email recipients. Required when a CC role exists for the Template.

client_idstringrequired

Client id of the app you're using to create this embedded signature request. Used for security purposes.

custom_fieldsSubCustomField

An array defining values and options for custom fields. Required when a custom field exists in the Template.

filesarray

Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.

file_urlsarray

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.

messagestring

The custom message in the email that will be sent to the signers.

metadataobject

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.

signersSubSignatureRequestTemplateSignerrequired

Add Signers to your Templated-based Signature Request.

signing_optionsSubSigningOptions

subjectstring

The subject in the email that will be sent to the signers.

test_modeboolean

Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.

titlestring

The title you want to assign to the SignatureRequest.

populate_auto_fill_fieldsboolean

Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-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.