Skip to main content
Update Comment
Updates a comment’s content, its metadata, or both. Only the comment’s author, or a request with a service or master key, can update a comment. Authentication required.

Path Parameters

string
required
The UUID of the comment to update.

Body Parameters

Both fields are individually optional, but at least one must be provided.
string
The new text content for the comment. Leading and trailing whitespace is trimmed. Cannot be empty or only whitespace. Omit to leave the existing content untouched.
object
Arbitrary JSON metadata, up to 10 KB (10,240 bytes) as JSON. Replaces the stored metadata wholesale rather than merging into it.

Deleted and removed comments

A comment its author deleted, and a comment a moderator removed, can’t be edited: the request returns 404 comment/not-found. This includes the author of a moderator-removed comment, who still sees it in full.

Blocks

Editing changes content in someone else’s space, so when the moderation bundle is installed, editing is refused with 404 comment/not-found when the author of the comment’s entity, or the author of the comment it replies to, has blocked the comment’s author. Deleting the comment is still allowed. Requests made with a master key aren’t subject to this check. A comment on an entity whose author has blocked the caller is hidden from them, so when the caller isn’t the comment’s author, the edit is refused with 404 comment/not-found — the same response as a missing comment, not a 403. This check also applies only when the moderation bundle is installed, and requests made with a service or master key aren’t subject to it.

Response

Returns the updated Comment object in full, as the caller sees it.

Error Responses

No Authorization header was sent. The body is text/plain (Unauthorized), not JSON. An expired or invalid token returns 403 instead — see Authentication.
Returned when commentId isn’t a valid UUID.
Returned when neither content nor metadata is supplied, when content is an empty string or only whitespace, when metadata isn’t an object, or when metadata is larger than 10 KB.
Returned when your project’s comment.updated validation webhook doesn’t approve the edit. Nothing is changed. error is the message your webhook responded with, when it sent one.
Returned when the comment doesn’t exist, when its author deleted it or a moderator removed it (see Deleted and removed comments), or when a block refuses the edit — including when the caller isn’t the comment’s author and the author of the comment’s entity has blocked them (see Blocks).
Returned when the caller isn’t the comment’s author and isn’t using a service or master key.