API Reference
Status PageRoadmapTestimoniesShare feedback

Update a Signature Request

patch
https://api-sandbox.yousign.app/v3/signature_requests/

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…
Path Params
uuid
required

Signature Request Id

Body Params
string
length between 1 and 128

This property is a Safe String.

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
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

This property is a Safe String allowing email.

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.

string | null
uuid | null
deprecated
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
labels
array of uuids
length ≤ 50

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

labels
Responses

Updated 9 days ago

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

Updated 9 days ago