Edit a comment. Replaces a comment's Markdown body (and, for the team, its mentions). Authors edit their own; managers and owners edit any. Visibility can't change. Pass expected_version from list_comments to avoid overwriting another edit. Teammates newly mentioned are notified (and emailed, per their settings); nobody else is emailed.
Toolset
core
Who can call it
OwnersManagersContributorsCustomersAPI keys
REST
PATCH /api/v1/w/{workspace}/comments/{comment}
Behavior
changes dataidempotent
Input
Field
Type
Description
commentrequired
string
ID with prefix "cmt_"
bodyrequired
string
Markdown. Raw HTML is shown as text, not rendered.
mentions
array of string
Replaces the mention list; omit to keep it.
expected_version
integer
Output
Field
Type
Description
idrequired
string
ID with prefix "cmt_"
post_idrequired
string
ID with prefix "pst_"
parent_idrequired
string or null
The comment this replies to; null at the top level.
authorrequired
object
bodyrequired
string or null
Markdown; null once the comment is deleted.
visibilityrequired
one of: public, internal
public: everyone who can see the post. internal: team members only.
mentionsrequired
array of object
deletedrequired
boolean
Shown only to keep a deleted comment's replies in place.