Update a Signature Request

patch

https://api-sandbox.yousign.app/v3/signature_requests/{signatureRequestId}

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

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

signatureRequestId

uuid

required

Signature Request Id

Body Params

name

string

length between 1 and 128

This property is a Safe String.

delivery_mode

string

enum

Delivery mode to notify signers.

Allowed:

ordered_signers

boolean

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

ordered_approvers

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

timezone

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.

email_custom_note

string | null

deprecated

This property is a Safe String allowing email.

expiration_date

date

Due date of the Signature Request (yyyy-mm-dd).
The date cannot be in the past and cannot be more than one year after initiation.

external_id

string | null

branding_id

uuid | null

deprecated

custom_experience_id

uuid | null

Use a specific Custom Experience to customize the signature experience.

signers_allowed_to_decline

boolean

Defaults to false

Allowing signers to decline to sign.

workspace_id

uuid | null

Transfer the Signature Request into a given Workspace.

audit_trail_locale

string | null

enum

Define the locale for the generated audit trail.

Allowed:

email_notification

object | null

labels

array of uuids

length ≤ 50

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

labels

Responses

200OK

400Bad request

401Access unauthorized

403Access forbidden

404Resource not found

405This method is not allowed

415UnsupportedMediaType

429Too Many Requests, please try again later.

500Internal Server Error