API Reference
Status PageRoadmapTestimoniesShare feedback

Update a Signer

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

Updates a given Signer. Any parameters not provided are left unchanged.

Path Params
uuid
required

Signature Request Id

uuid
required

Signer Id

Body Params
info
object | null
uuid | null

ID of the recipient this one must follow in an ordered flow; they will only be asked to act after that recipient. When custom_recipient_order is enabled, this can reference any approver or signer. When custom_recipient_order is disabled, the referenced ID must be a signer. ordered_signers must be enabled on the Signature Request.

uuid | null

ID of another recipient (Approver or Signer); both will be allowed to act in parallel in an ordered flow. Only available when custom_recipient_order is enabled.

string
enum
Defaults to electronic_signature
Allowed:
string | null
enum

Method to authenticate the Signers. Authentication via SMS one-time password (otp_sms) is unavailable for phone numbers in China. When the Signature Request in draft status, updating the authentication mode is available for all Signers, no matter their signature_level.
When the Signature Request is in approval or ongoing status, updating the authentication mode is only available for Simple Electronic Signature if Signers have an initiated or notified status.

Allowed:
redirect_urls
object
custom_text
object
string | null
enum

Override the delivery mode of the Signature Request for this Signer

Allowed:
string | null
email_notification
object | null
boolean

Defines the way the Signer's Identity Documents will be uploaded for Verification. If set to true, signature_levelshould be equal to advanced_electronic_signature and delivery_mode set to none.

Responses

Updated 11 days ago

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