Send Signature Request
Creates and sends a new SignatureRequest with the submitted documents. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents.
Your API key can be used to make calls to the Dropbox Sign API. See Authentication for more information.
ā
Supported by Try it console (calls sent in test_mode only).
In: header
Use files[] to indicate the uploaded file(s) to send for signature.
This endpoint requires either files or file_urls[], but not both.
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.
Add Signers to your Signature Request.
This endpoint requires either signers or grouped_signers, but not both.
Add Grouped Signers to your Signature Request.
This endpoint requires either signers or grouped_signers, but not both.
Allows signers to decline to sign a document if true. Defaults to false.
falseAllows signers to reassign their signature requests to other signers if set to true. Defaults to false.
NOTE: Only available for Premium plan and higher.
falseA list describing the attachments
The email addresses that should be CCed.
The 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.
When 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 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 and then passing custom_fields on subsequent signature requests referencing that template.
This allows the requester to specify field options for a signature request.
Group 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.
Conditional Logic rules for fields defined in form_fields_per_document.
The 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.)
NOTE: Fields like text, dropdown, checkbox, radio, and hyperlink have additional required and optional parameters. Check out the list of additional parameters 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
Enables 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 for more information.
falseSend 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.
NOTE: You need the eID add-on to use this feature. Please contact sales for more information. Cannot be used in test_mode. Only works on requests with one signer.
falseThe custom message in the email that will be sent to the signers.
length <= 5000Key-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.
items <= 10This allows the requester to specify the types allowed for creating a signature and specify another signing options.
NOTE: If signing_options are not defined in the request, the allowed types will default to those specified in the account settings.
NOTE: If force_advanced_signature_details is set, allowed types has to be defined too.
The URL you want signers redirected to after they successfully sign.
The subject in the email that will be sent to the signers.
length <= 255Whether this is a test, the signature request will not be legally binding if set to true. Defaults to false.
falseThe title you want to assign to the SignatureRequest.
length <= 255Send with a value of true if you wish to enable Text Tags parsing in your document. Defaults to disabled, or false.
falseSent with a value of true to ignore the validation errors from text tags extraction. Defaults to false.
falseWhen the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See Signature Request Expiration Date for details.
Response Body
application/json
application/json
curl -X POST "https://example.com/signature_request/send" \ -H "Content-Type: application/json" \ -d '{ "title": "NDA with Acme Co.", "subject": "The NDA we talked about", "message": "Please sign this NDA and then we can discuss more. Let me know if you\\nhave any questions.", "signers": [ { "email_address": "jack@example.com", "name": "Jack", "order": 0 }, { "email_address": "jill@example.com", "name": "Jill", "order": 1 } ], "cc_email_addresses": [ "lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com" ], "file_urls": [ "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" ], "metadata": { "custom_id": 1234, "custom_text": "NDA #9" }, "signing_options": { "draw": true, "type": true, "upload": true, "phone": false, "default_type": "draw", "force_advanced_signature_details": false }, "field_options": { "date_format": "DD - MM - YYYY" }, "test_mode": true }'{ "signature_request": { "signature_request_id": "2b388914e3ae3b738bd4e2ee2850c677e6dc53d2", "title": "NDA with Acme Co.", "original_title": "The NDA we talked about", "subject": "The NDA we talked about", "message": "Please sign this NDA and then we can discuss more. Let me know if you have any questions.", "test_mode": true, "metadata": { "custom_id": "1234", "custom_text": "NDA #9" }, "created_at": 1570471067, "is_complete": false, "is_declined": false, "has_error": false, "custom_fields": [], "response_data": [], "signing_url": "https://app.hellosign.com/sign/2b388914e3ae3b738bd4e2ee2850c677e6dc53d2", "signing_redirect_url": null, "files_url": "https://api.hellosign.com/v3/signature_request/files/2b388914e3ae3b738bd4e2ee2850c677e6dc53d2", "details_url": "https://app.hellosign.com/home/manage?guid=2b388914e3ae3b738bd4e2ee2850c677e6dc53d2", "requester_email_address": "me@dropboxsign.com", "signatures": [ { "signature_id": "78caf2a1d01cd39cea2bc1cbb340dac3", "signer_email_address": "jack@example.com", "signer_name": "Jack", "signer_role": null, "order": 0, "status_code": "awaiting_signature", "signed_at": null, "last_viewed_at": null, "last_reminded_at": null, "has_pin": false, "has_sms_auth": false }, { "signature_id": "616629ed37f8588d28600be17ab5d6b7", "signer_email_address": "jill@example.com", "signer_name": "Jill", "signer_role": null, "order": 1, "status_code": "awaiting_signature", "signed_at": null, "last_viewed_at": null, "last_reminded_at": null, "has_pin": false, "has_sms_auth": false } ], "cc_email_addresses": [ "lawyer1@dropboxsign.com", "lawyer2@example.com" ], "attachments": [ { "id": "id_1", "signer": "1", "name": "Attachment #1", "required": true, "instructions": "Instructions #1", "uploaded_at": 1650398513 }, { "id": "id_2", "signer": "2", "name": "Attachment #2", "required": true, "instructions": null, "uploaded_at": null } ], "template_ids": null }}Remove Signature Request Access POST
Removes your access to a completed signature request. This action is **not reversible**. The signature request must be fully executed by all parties (signed or declined to sign). Other parties will continue to maintain access to the completed signature request document(s). Unlike /signature_request/cancel, this endpoint is synchronous and your access will be immediately removed. Upon successful removal, this endpoint will return a 200 OK response.
Send with Template POST
Creates and sends a new SignatureRequest based off of the Template(s) specified with the `template_ids` parameter.