Skip to content

Delete a comment

DELETE
/comments/{id}

Deletes a comment of any kind: a comment or reply on a post, a whiteboard sketch or a text annotation. The comment is kept but marked deleted, and its text is cleared; nothing else in it is removed.

You need to be signed in. A comment that doesn’t exist or is already deleted answers 404. You can delete your own comments if you hold comments.delete.own (part of the Base role), and with comments.delete.any or system.admin you can delete anyone’s. Being the author of the post or the owner of the asset isn’t enough to delete other people’s comments, and you don’t need to be able to read the post or asset the comment is on. Comments received from another instance can be deleted only with comments.delete.any or system.admin. Anyone else gets 403.

A sketch’s drawing and an annotation’s range stay stored, along with the author, times and likes, and replies aren’t deleted. Deleting a top-level comment drops its whole thread, replies included, from the post’s comment list; deleting a reply leaves replies to it listed. Deleting a comment on a post lowers its comment_count by one, never below zero; comments on assets have no count. Earlier copies, such as notices already created and the activity recorded when a post comment was made, aren’t changed.

The deletion and a delete activity are saved together, and a second request for the same comment answers 404. Nobody is notified. The post’s cached details are refreshed afterwards on a best-effort basis.

id
required
string format: uuid

The comment’s id.

The comment was deleted.

Authentication required, missing, or invalid

object
error
required

Human-readable error summary

string
Example
the request could not be completed
Example
{
"error": "authentication required: sign in and retry with a valid session or API token"
}

Authenticated but missing required capabilities

object
error
required

Human-readable error summary

string
Example
the request could not be completed

Resource not found

object
error
required

Human-readable error summary

string
Example
the request could not be completed