ConnectCloud Developers

Delete a document (tenant:dms:write)

DELETE /api/dms/v1/documents/{id}

Module: DMS · operationId: deleteDocument · Tag: Documents · Auth: access token (Authorization: Bearer <accessToken>)

Soft delete: the document disappears from the API, its record, hashes and audit trail stay (GoBD) and the files are purged later. Refused with 409 while the document is under legal hold, under an active WORM lock, or its retention period (retentionUntil) has not ended. The optional body records a reason in the audit trail.

Parameters

Name In Type Required Description
id path string (uuid) yes

Request body

application/json

  • reason (string): Recorded in the audit trail

Example:

{
  "reason": "Doppelt erfasst"
}

Responses

  • 204 Deleted
  • 400 Error (application/json)
  • 404 Error (application/json)
  • 409 Error (application/json)

Example request

curl -X DELETE 'https://api.mbcom.cloud/api/dms/v1/documents/3f2b8c1e-7d4a-4e9b-9c2a-5b1d6e8f0a12' \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  --data '{"reason":"Doppelt erfasst"}'

View as Markdown · Interactive reference · OpenAPI