Update Signature Request

post/signature_request/update/{signature_request_id}

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.

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

Securityapi_key or oauth2
Request
path Parameters
signature_request_id
required
string

The id of the SignatureRequest to update.

Example: fa5c8a0b0f492d768749333ad6fcc214c111e967
Request Body schema: application/json
signature_id
required
string

The signature ID for the recipient.

email_address
string <email>

The new email address for the recipient.

NOTE: Optional if name is provided.

name
string

The new name for the recipient.

NOTE: Optional if email_address is provided.

Responses
200

successful operation

4XX

failed_operation

Request samples
application/json
{
  • "email_address": "john@example.com",
  • "signature_id": "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"
}
Response samples
application/json
{
  • "signature_request": {
    }
}