Delete Document Comment

Soft delete a comment: remove it from the owning record’s embedded comments and comment IDs, decrement the count, and set removedAt on the stored comment record. Requires authentication, the DOCUMENTS feature flag, and ADMIN, DELETE_COMMENT, UPDATE_DOCUMENT, or MANAGE_DOCUMENTS permissions.

Parameters

name * are required parameters	data type	description
documentId*	string	The unique identifier of the document.
commentId*	string	The unique identifier of the comment.
body.path*	string	Full Firestore path of the document or draft that owns the comments. Do not include /comments/:commentId or an /api prefix.

body.path selects the record whose comment collection and embedded comment metadata are updated. For a site draft, use sites/:siteId/S_:siteId/:siteId/documents/:documentId/versions/draft, replacing every placeholder with its actual ID. This Firestore path is distinct from the HTTP target path.

Return Value

HTTP 201 Created. The JSON body is:

{
  "message": "Successfully deleted the comment",
  "data": null
}

Examples

bash

curl -X POST "https://app.wombat.software/api/{targetPath}/document/:documentId/comment/:commentId/delete" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer ..."