Signature Request

Update Signature Request

Updates the email address and/or the name for a given signer on a signature request. You can listen for the signature_request_email_bounce event on your app or account to detect bounced emails, and respond with this method.

Updating the email address of a signer will generate a new signature_id value.

NOTE: This action cannot be performed on a signature request with an appended signature page.

post/signature_request/update/{signature_request_id}

Path parameters

signature_request_idstring required

The id of the SignatureRequest to update.

Request body

email_addressstring email

The new email address for the recipient.

This will generate a new signature_id value.

NOTE: Optional if name is provided.

namestring

The new name for the recipient.

NOTE: Optional if email_address is provided.

signature_idstring required

The signature ID for the recipient.

expires_atinteger nullable

The new time 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 6 of the 53 revisions of this API.713

    • 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

    • 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

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

      response-optional-property-added

    • the response property signature_request/custom_fields/items/editor became nullable for the status 200

      response-property-became-nullable

    • the response property signature_request/expires_at became nullable for the status 200

      response-property-became-nullable

    • the response property signature_request/requester_email_address became nullable for the status 200

      response-property-became-nullable

    • the response property signature_request became required for the status 200

      response-property-became-required

    • the response property signature_request/test_mode became nullable for the status 200

      response-property-became-nullable

    • the response property signature_request became optional for the status 200

      response-property-became-optional

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