Docmost Octri Preview
POST/comments/resolve

Resolve or unresolve a comment

Changes whether a comment is resolved or unresolved. Supply commentId as a UUID and set resolved to true to resolve the comment or false to unresolve it.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

2 body fields

The comment identifier and the resolution state to apply.

commentIdstringrequired
ID of the comment to resolve or unresolve.
resolvedbooleanrequired
Set to `true` to resolve the comment, `false` to unresolve it.

4 status codes
200Returns the updated comment.
dataobjectoptional
statusintegeroptional
successbooleanoptional
400Returned when the comment is a reply and cannot be resolved.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional
403Returned when changing the comment's resolution state is forbidden.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional
404Returned when the comment does not exist.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional

Error handling

A 400 is returned when the comment is a reply that cannot be resolved. A 403 is returned when the authenticated user is not permitted to change the comment's resolution state. A 404 is returned when no comment exists with the supplied commentId.