Skip to content

Add Document Comment

Add a comment to a document. Requires the DOCUMENTS feature flag and ADMIN, ADD_COMMENT, UPDATE_DOCUMENT, or MANAGE_DOCUMENTS permissions.

Parameters

name * are required parametersdata typedescription
documentId*stringThe unique identifier of the document
body.text*stringThe comment text content

Return Value

The created comment record.

Examples

bash
curl -X PUT "https://app.wombat.software/api/{targetPath}/document/:documentId/comment" \
  -H "Content-Type: application/json" \
  -H "Authentication: Bearer ..." \
  -d '{"text": "Please review section 3."}'

ENDPOINTS

put/api/{targetPath}/document/:documentId/comment