API ReferenceSignature Request

Update Signature Request

View as Markdown
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.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <username:password>.

OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

signature_request_idstringRequired
The id of the SignatureRequest to update.

Request

This endpoint expects an object.
signature_idstringRequired
The signature ID for the recipient.
email_addressstringOptionalformat: "email"

The new email address for the recipient.

This will generate a new signature_id value.

NOTE: Optional if name is provided.

namestringOptional

The new name for the recipient.

NOTE: Optional if email_address is provided.

expires_atinteger or nullOptional

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 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 or null
A list of warnings.

Errors