v1

latestOpenAPI 3.0.3MIT2026-07-1373217576.0 KB

Signature Request

Create Embedded Signature Request with Template

Creates a new SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.

post/signature_request/create_embedded_with_template

Request body

template_idsstring[] required

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.

client_idstring required

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

filesstring[]

Use files[] to indicate the uploaded file(s) to send for signature.

This endpoint requires either files or file_urls[], but not both.

file_urlsstring[]

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.

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 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.

Response

successful operation