Docmost Octri Preview
POST/comments/update

Update a comment

Updates the content of an existing comment, replacing its entire current body. Supply commentId as a UUID and content as a JSON string in ProseMirror document format.

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

2 body fields

The comment identifier and replacement content.

commentIdstringrequired
ID of the comment to update.
contentstringrequired
New comment body as a JSON string (ProseMirror document format). Replaces the entire comment content.

3 status codes
200Returns the updated comment.
dataobjectoptional
statusintegeroptional
successbooleanoptional
403Returned when updating the comment 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 403 is returned when the authenticated user is not permitted to update the comment. A 404 is returned when no comment exists with the supplied commentId.