OPENAPI / COMPONENTS / SCHEMAS
Signature Request Send Request
SignatureRequestSendRequestSignatureRequestSendRequest data structure
filesarrayUse `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.
file_urlsarrayUse `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.
signersSubSignatureRequestSignerAdd Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both.
grouped_signersSubSignatureRequestGroupedSignersAdd Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both.
allow_declinebooleanAllows signers to decline to sign a document if `true`. Defaults to `false`.
allow_reassignbooleanAllows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher.
attachmentsSubAttachmentA list describing the attachments
cc_email_addressesarrayThe email addresses that should be CCed.
client_idstringThe client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app.
custom_fieldsSubCustomFieldWhen used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template.
field_optionsSubFieldOptionsform_field_groupsSubFormFieldGroupGroup information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`.
form_field_rulesSubFormFieldRuleConditional Logic rules for fields defined in `form_fields_per_document`.
form_fields_per_documentSubFormFieldsPerDocumentBaseThe fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`
hide_text_tagsbooleanEnables automatic Text Tag removal when set to true. **NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information.
is_eidbooleanSend with a value of `true` if you wish to enable [electronic identification (eID)](https://sign.dropbox.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br> **NOTE:** You need the eID add-on to use this feature. Please [contact sales](https://sign.dropbox.com/form/contact-sales) for more information. Cannot be used in `test_mode`. Only works on requests with one signer.
messagestringThe custom message in the email that will be sent to the signers.
metadataobjectKey-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_optionsSubSigningOptionssigning_redirect_urlstringThe URL you want signers redirected to after they successfully sign.
subjectstringThe subject in the email that will be sent to the signers.
test_modebooleanWhether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.
titlestringThe title you want to assign to the SignatureRequest.
use_text_tagsbooleanSend with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`.
expires_atintegerWhen the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.