Update a Signer

patch

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

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

signatureRequestId

uuid

required

Signature Request Id

signerId

uuid

required

Signer Id

Body Params

info

object | null

insert_after_id

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.

group_with_id

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.

signature_level

string

enum

Defaults to electronic_signature

Allowed:

signature_authentication_mode

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

delivery_mode

string | null

enum

Override the delivery mode of the Signature Request for this Signer

Allowed:

identification_attestation_id

string | null

email_notification

object | null

pre_identity_verification_required

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.

excluded_documents

array of uuids

List of Document IDs not visible to this Recipient. When omitted, the Recipient can see all Documents. Only available when the document_visibility feature is enabled on the organization.

excluded_documents

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