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

application/json

Body

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

name string
note string
description 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.

Responses

200

Document updated successfully!

application/json

Schema

Schema

objectId string
updatedAt date

Example (from schema)

{
  "objectId": "asd2HsP4Hp",
  "updatedAt": "2023-10-07T16:49:56.000Z"
}

400

Please provide valid field names!

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "Please provide valid field names!"
}

404

Document not found!

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "Document not found!"
}

405

Invalid API Token!

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "Invalid API token!"
}

Loading...