Sign in
Signature Request

Edit Embedded Signature Request

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.

put/signature_request/edit_embedded/{signature_request_id}

Path parameters

signature_request_idstring required

The id of the SignatureRequest to edit.

Request body

filesstring[]

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

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

file_urlsstring[]

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.

allow_declineboolean

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

allow_reassignboolean

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

NOTE: Only available for Premium plan.

cc_email_addressesstring[]

The email addresses that should be CCed.

client_idstring required

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

hide_text_tagsboolean

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.

messagestring

The custom message in the email that will be sent to the signers.

metadataobject

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.

subjectstring

The subject in the email that will be sent to the signers.

test_modeboolean

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

titlestring

The title you want to assign to the SignatureRequest.

use_text_tagsboolean

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

ignore_text_tags_extraction_errorsboolean

Sent with a value of true to ignore the validation errors from text tags extraction. Defaults to false.

populate_auto_fill_fieldsboolean

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 nullable

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

successful operation

Changes

Changed in 9 of the 53 revisions of this API.6712

  • 2998c4df4efd2See the full diff
    • ○

      added the new optional request property ignore_text_tags_extraction_errors (media type: application/json)

      new-optional-request-property

    • ○

      added the new optional request property ignore_text_tags_extraction_errors (media type: multipart/form-data)

      new-optional-request-property

  • b01e1bcfb3353See the full diff
    • ●

      removed the request property signer_experience (media type: application/json)

      request-property-removed

    • ●

      removed the request property signer_experience (media type: multipart/form-data)

      request-property-removed

    • ●

      removed the optional property signature_request/signer_experience from the response with the 200 status

      response-optional-property-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 91fb636b886921See the full diff
    • ▲

      the signature_request/signer_experience response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • ▲

      removed the required property signature_request/signer_experience/form_view from the response with the 200 status

      response-required-property-removed

    • ○

      added SignatureRequestSignerExperience to the signature_request/signer_experience response property allOf list for the response status 200

      response-property-all-of-added

  • 28265b951078321See the full diff
    • ▲

      added SubSignerExperience to the signer_experience request property allOf list (media type: application/json)

      request-property-all-of-added

    • ▲

      added SubSignerExperience to the signer_experience request property allOf list (media type: multipart/form-data)

      request-property-all-of-added

    • ▲

      the signer_experience request property type/format changed from object/ to / (media type: application/json)

      request-property-type-changed

    • ●

      removed the request property signer_experience/form_view (media type: application/json)

      request-property-removed

    • ●

      removed the request property signer_experience/form_view (media type: multipart/form-data)

      request-property-removed

    • ○

      the signer_experience request property type/format was generalized from object/ to / (media type: multipart/form-data)

      request-property-type-generalized

  • 5d5587f226822See the full diff
    • ○

      added the new optional request property signing_options/force_advanced_signature_details (media type: application/json)

      new-optional-request-property

    • ○

      added the new optional request property signing_options/force_advanced_signature_details (media type: multipart/form-data)

      new-optional-request-property

  • 62839e1fd88623See the full diff
    • ●

      removed the request property allow_form_view (media type: application/json)

      request-property-removed

    • ●

      removed the request property allow_form_view (media type: multipart/form-data)

      request-property-removed

    • ○

      added the new optional request property signer_experience (media type: application/json)

      new-optional-request-property

    • ○

      added the new optional request property signer_experience (media type: multipart/form-data)

      new-optional-request-property

    • ○

      added the optional property signature_request/signer_experience to the response with the 200 status

      response-optional-property-added

  • 0ee14bf79f552See the full diff
    • ○

      added the new optional request property allow_form_view (media type: application/json)

      new-optional-request-property

    • ○

      added the new optional request property allow_form_view (media type: multipart/form-data)

      new-optional-request-property

  • 8d3cf751f85f1See the full diff
    • ○

      endpoint added

      endpoint-added

  • e9603b26e6f81See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 49 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog