Update a Signature Request

Updates a given Signature Request. Any parameters not provided are left unchanged.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Related guide: Signature Request


🔓 Endpoint access

  • Environments: production, sandbox
  • API key scopes: organization, workspace
  • Plans: plus, pro, scale
  • Add-ons (for production access): none
Path Params
uuid
required

Signature Request Id

Body Params
string
length between 1 and 128

Name of the Signature Request.

string
enum

Delivery mode to notify signers.

Allowed:
boolean

Enable an ordered workflow, each signer will be requested to sign in a sequential order

boolean

When enabled, Approvers are requested to approve sequentially.
Each Approver will be invited to approve only once the previous one has completed their approval.

reminder_settings
object | null

Automatic reminder configuration; set to null to disable.

string
Defaults to Europe/Paris

Time zone of the dates and times displayed in emails, the Signature Request expiration date, and the PDF Audit Trail. Format: tz database. Default is set to Europe/Paris.

string | null
deprecated

Deprecated; use email_notification.custom_text instead.

string
^\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])(T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9])?$

Due date of the Signature Request, in the timezone sent in the same request, or the current one.
Accepted formats:

  • yyyy-mm-dd: the Signature Request expires at 23:59:59 on that day.
  • yyyy-mm-ddThh:mm:ss: the Signature Request expires at that time.
    Time offsets (Z, +02:00) are not accepted. Responses return the expiration date in UTC.
    On a draft, a date other than the current one sets a fixed due date that no longer depends on when the Signature Request is activated.
    The date cannot be in the past and cannot be more than one year from today.
    On a draft scheduled for sending, the date must be after the scheduled sending date.
string | null
^[\w\-@.%+]+$

Custom identifier added to webhooks and appended to redirect URLs.

uuid | null
deprecated

Deprecated. Identifier of the branding to apply; use custom_experience_id instead.

uuid | null

Use a specific Custom Experience to customize the signature experience.

boolean
Defaults to false

Allowing signers to decline to sign.

uuid | null

Transfer the Signature Request into a given Workspace.

string | null
enum

Define the locale for the generated audit trail.

Allowed:
email_notification
object | null

Email notification configuration for recipients.

embedded_preparation
object | null

Embedded Preparation settings for this Signature Request.

labels
array of uuids
length ≤ 50

List of Labels to associate with the Signature Request. Labels are identified by their ID.

labels
Responses

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json