Documents

Delete a document

Removes a document from the archive. The record and its sealed versions are kept internally (this is a soft delete), but it stops appearing anywhere. REFUSED for a document in digital preservation or under legal hold — a retention term binds only once the document is preserved (0324) — and the database enforces that, so do not try to work around it. A mail message filed in the archive may be removed too: the message stays in its mailbox and reads as not archived again. Ask the user to confirm before calling this.

Examples

  • Delete that duplicate upload DELETE /api/v1/rest/documents/11111111-2222-4333-8444-555555555555
delete/api/v1/rest/documents/{id}

Request

  • Base URL: https://api.custodo.ai
  • URL: https://api.custodo.ai/api/v1/rest/documents/{id}
  • 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.

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.