Sign in
Signature Request

Edit Signature Request With Template

Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter.

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

put/signature_request/edit_with_template/{signature_request_id}

Path parameters

signature_request_idstring required

The id of the SignatureRequest to edit.

Request body

template_idsstring[] required

Use template_ids to create a SignatureRequest from one or more templates, in the order in which the template will be used.

allow_declineboolean

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

client_idstring

Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app.

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.

is_eidboolean

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

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.

signing_redirect_urlstring

The URL you want signers redirected to after they successfully sign.

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.

Response

successful operation

Changes

Changed in 7 of the 53 revisions of this API.658

  • 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

  • 62839e1fd8863See the full diff
    • ○

      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

  • 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