Skip to main content

Update Document

PUT 
/document/:document_id

The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.

Request​

Path Parameters

    document_id stringrequired

    ID of the document that needs to be updated

Body

Provide below parameter to update templates (at least one parameter required)

    name string
    note string
    folderId string
    enableOTP boolean

    true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.

    enableTour boolean

    true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.

    allow_modifications boolean

    true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.

Responses​

Document updated successfully!

Schema

    objectId string
    updatedAt date
Loading...