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.
files | Array of strings <binary> Use This endpoint requires either files or file_urls[], but not both. |
file_urls | Array of strings Use This endpoint requires either files or file_urls[], but not both. |
Array of objects (SubSignatureRequestSigner) Add Signers to your Signature Request. This endpoint requires either signers or grouped_signers, but not both. | |
Array of objects (SubSignatureRequestGroupedSigners) Add Grouped Signers to your Signature Request. This endpoint requires either signers or grouped_signers, but not both. | |
allow_decline | boolean Default: false Allows signers to decline to sign a document if |
allow_reassign | boolean Default: false Allows signers to reassign their signature requests to other signers if set to NOTE: Only available for Premium plan and higher. |
Array of objects (SubAttachment) A list describing the attachments | |
cc_email_addresses | Array of strings <email> The email addresses that should be CCed. |
client_id | string 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. |
Array of objects (SubCustomField) When used together with merge fields, Pre-filled data can be used with "send-once" signature requests by adding merge fields with 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 | |
object (SubFieldOptions) This allows the requester to specify field options for a signature request. | |
Array of objects (SubFormFieldGroup) Group information for fields defined in | |
Array of objects (SubFormFieldRule) Conditional Logic rules for fields defined in | |
Array of objects (SubFormFieldsPerDocumentBase) 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.
| |
hide_text_tags | boolean Default: false 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 |
is_eid | boolean Default: false Send with a value of |
message | string <= 5000 characters The custom message in the email that will be sent to the signers. |
object <= 10 items 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. | |
object (SubSigningOptions) This allows the requester to specify the types allowed for creating a signature. NOTE: If | |
signing_redirect_url | string The URL you want signers redirected to after they successfully sign. |
subject | string <= 255 characters The subject in the email that will be sent to the signers. |
test_mode | boolean Default: false Whether this is a test, the signature request will not be legally binding if set to |
title | string <= 255 characters The title you want to assign to the SignatureRequest. |
use_text_tags | boolean Default: false Send with a value of |
expires_at | integer or null When 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. |
successful operation
failed_operation
{- "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"
], - "metadata": {
- "custom_id": 1234,
- "custom_text": "NDA #9"
}, - "signing_options": {
- "draw": true,
- "type": true,
- "upload": true,
- "phone": false,
- "default_type": "draw"
}, - "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_redirect_url": null,
- "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
}
}