Documents

Put a document under legal hold, or release it

A legal hold blocks EVERY deletion path for a document, including retention sweeps — it is what you apply when a document is evidence in a dispute. Releasing one lets the ordinary retention rules resume. Always record why: the reason is the entire evidentiary value of the entry.

put/api/v1/rest/documents/{id}/legal-hold

Request

  • Base URL: https://api.custodo.ai
  • URL: https://api.custodo.ai/api/v1/rest/documents/{id}/legal-hold
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Headers

X-Tenant-Idstring uuid

The organisation to act in. An API key is bound to exactly one, so this is optional for a key and must match the one it was minted for.

Request body

legal_holdboolean required

true to apply the hold, false to release it.

reasonstring required

Why. Recorded in the activity log.

Response

Done. data is the tool’s own answer.

oktrue required
dataunknown required

Changes

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