Dropbox Sign Developer Documentation

curl -X POST 'https://api.hellosign.com/v3/signature_request/edit_embedded/{signature_request_id}' \
  -u 'YOUR_API_KEY:' \
  -F 'client_id=YOUR_CLIENT_ID' \
  -F 'files[0]=@mutual-NDA-example.pdf' \
  -F 'title=NDA with Acme Co.' \
  -F 'subject=The NDA we talked about' \
  -F 'message=Please sign this NDA and then we can discuss more. Let me know if you have any questions.' \
  -F 'signers[0][email_address]=jack@example.com' \
  -F 'signers[0][name]=Jack' \
  -F 'signers[0][order]=0' \
  -F 'signers[1][email_address]=jill@example.com' \
  -F 'signers[1][name]=Jill' \
  -F 'signers[1][order]=1' \
  -F 'cc_email_addresses[]=lawyer1@dropboxsign.com' \
  -F 'cc_email_addresses[]=lawyer2@dropboxsign.com' \
  -F 'signing_options[draw]=1' \
  -F 'signing_options[type]=1' \
  -F 'signing_options[upload]=1' \
  -F 'signing_options[phone]=1' \
  -F 'signing_options[default_type]=draw' \
  -F 'test_mode=1'

{
  "signature_request": {
    "signature_request_id": "a9f4825edef25f47e7b4c14ce8100d81d1693160",
    "requester_email_address": "me@dropboxsign.com",
    "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.",
    "metadata": {},
    "created_at": 1570471067,
    "is_complete": false,
    "is_declined": false,
    "has_error": false,
    "signing_url": null,
    "details_url": "https://app.hellosign.com/home/manage?guid=a9f4825edef25f47e7b4c14ce8100d81d1693160",
    "cc_email_addresses": [
      "lawyer1@dropboxsign.com",
      "lawyer2@dropboxsign.com"
    ],
    "signing_redirect_url": null,
    "custom_fields": [],
    "response_data": [],
    "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
      }
    ]
  }
}

Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. 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. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.

NOTE: Edit and resend will deduct your signature request quota.

Authentication

AuthorizationBasic

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

AuthorizationBearer

You can use an Access Token issued through an OAuth flow to send calls to the Dropbox Sign API from your app. The access scopes required by this endpoint are listed in the gray box above. See [Authentication](/api/reference/authentication) for more information. ❌ **Not supported** by Try it console.

Path parameters

signature_request_idstringRequired

The id of the SignatureRequest to edit.

Request

This endpoint expects an object.

client_idstringRequired

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

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.

signerslist of objectsOptional

Add Signers to your Signature Request.

This endpoint requires either signers or grouped_signers, but not both.

grouped_signerslist of objectsOptional

Add Grouped Signers to your Signature Request.

This endpoint requires either signers or grouped_signers, but not both.

allow_declinebooleanOptionalDefaults to false

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

allow_reassignbooleanOptionalDefaults to false

Allows signers to reassign their signature requests to other signers if set to true. Defaults to false.

NOTE: Only available for Premium plan.

attachmentslist of objectsOptional

A list describing the attachments

cc_email_addresseslist of stringsOptional

The email addresses that should be CCed.

custom_fieldslist of objectsOptional

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.

field_optionsobjectOptional

This allows the requester to specify field options for a signature request.

form_field_groupslist of objectsOptional

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.

form_field_ruleslist of objectsOptional

Conditional Logic rules for fields defined in form_fields_per_document.

form_fields_per_documentlist of objectsOptional

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

Variant:

hide_text_tagsbooleanOptionalDefaults to 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 false and instead hiding your text tags using white text or a similar approach. See the Text Tags Walkthrough for more information.

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

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.

use_text_tagsbooleanOptionalDefaults to false

Send with a value of true if you wish to enable Text Tags parsing in your document. Defaults to disabled, or false.

populate_auto_fill_fieldsbooleanOptionalDefaults to false

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.

expires_atinteger or nullOptional

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.

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

A list of warnings.

Errors

4XX

Client Request Error

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

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