API ReferenceSignature Request

Create Embedded Signature Request with Template

View as Markdown

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.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <username:password>.

OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
template_idslist of stringsRequired

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

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

Add Signers to your Templated-based Signature Request.

allow_declinebooleanOptionalDefaults to false

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

ccslist of objectsOptional
Add CC email recipients. Required when a CC role exists for the Template.
custom_fieldslist of objectsOptional
An array defining values and options for custom fields. Required when a custom field exists in the Template.
fileslist of stringsOptional

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

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

file_urlslist of stringsOptional

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.

messagestringOptional<=5000 characters
The custom message in the email that will be sent to the signers.
metadatamap from strings to anyOptional
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.
signing_optionsobjectOptional

This allows the requester to specify the types allowed for creating a signature.

NOTE: If signing_options are not defined in the request, the allowed types will default to those specified in the account settings.

subjectstringOptional<=255 characters
The subject in the email that will be sent to the signers.
test_modebooleanOptionalDefaults to false

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

titlestringOptional<=255 characters
The title you want to assign to the SignatureRequest.
populate_auto_fill_fieldsbooleanOptionalDefaults to false
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.

Response headers

X-RateLimit-Limitinteger
The maximum number of requests per hour that you can make.
X-RateLimit-Remaininginteger
The number of requests remaining in the current rate limit window.
X-Ratelimit-Resetinteger
The Unix time at which the rate limit will reset to its maximum.

Response

successful operation
signature_requestobject
Contains information about a signature request.
warningslist of objects or null
A list of warnings.

Errors