Document AI — DMS

Place legal hold

Place a legal hold on a document to block deletion and certain lifecycle transitions until explicitly released. Requires a compliance or administrator role with legal-hold permission on the workspace.

post/documents/document-legal-hold

Request

  • Base URL: https://api.paperoffice.ai/latest
  • URL: https://api.paperoffice.ai/latest/documents/document-legal-hold
  • Auth: HTTP bearer

Request body

pofidstring required

PaperOffice File ID

reasonstring required

Reason for the legal hold (required, e.g. lawsuit, audit).

referencestring

Optional reference (case ID, matter number).

Response

Success

status'success' required
_billingobject

Changes

No recorded changes to this operation across all 1 revision of this API.