API Reference
Status PageRoadmapTestimoniesShare feedback

Update a Document

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

Updates a given Document. 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

uuid
required

Document Id

Body Params
string
enum

Files in JPEG, JPG, and PNG format can only be of attachment nature.

Allowed:
uuid | null

Insert just after the position of the specified document id

string

The password required to unlock the document if it is protected

string
length between 1 and 128

The new name to be assigned to the document. This value should contain any characters except "", "/" and can't start and finish with a space.

initials
object | null
excluded_approvers
array of uuids

List of Approver IDs who cannot see this Document. When omitted, all Approvers can see it (default). Only available when the document_visibility feature is enabled on the organization.

excluded_approvers
excluded_signers
array of uuids

List of Signer IDs who cannot see this Document. When omitted, all Signers can see it (default). Requires the document_visibility feature to be enabled on the organization.

excluded_signers
Responses

Updated 7 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 7 days ago