Remove Document

Remove a document from the library. Locally managed documents are soft removed by setting removedAt on the root and draft records. Distributed copies are permanently deleted from the consuming target, along with their draft records and associated local files, and unlinked from the distributor. Requires authentication, the DOCUMENTS feature flag, and ADMIN, DELETE_DOCUMENT, or MANAGE_DOCUMENTS permissions.

Parameters

name * are required parameters	data type	description
documentId*	string	The unique identifier of the document.

No request body is used. Documents with children, missing documents, and already removed documents are rejected with HTTP 400. An open draft (version differs from draftVersion) must be discarded before removal unless the document has a distributor target string. Successful removal deletes the library metadata entry and parent child reference, and clears applicable role acknowledgment requirements.

Return Value

HTTP 201 Created. The JSON body is:

{
  "message": "Successfully removed the document",
  "data": null
}

Examples

bash

curl -X POST "https://app.wombat.software/api/{targetPath}/document/:documentId/remove" \
  -H "Authorization: Bearer ..."