Comment on an issue
Notifies everyone following the issue, minus the author. That is a wider audience than creator and assignee: those two are seeded as followers when the issue is created, but so is anyone later mentioned or assigned, and anyone who followed it themselves. A follower who has unsubscribed, or who is no longer on the issue's team, is excluded. A body containing @[Name](mention:memberId) tokens for members who can reach this issue additionally notifies each of them ("mentioned" instead of the generic "commented" when they would otherwise get both) and adds them as a follower of the issue. Imported comments (createdAt/authorEmail set) do not notify or process mentions.
View as MarkdownAuthorization
bearer In: header
Path Parameters
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/issues/497f6eca-6276-4993-bfeb-53cbbbba6f08/comments" \ -H "Content-Type: application/json" \ -d '{ "body": "string" }'{ "comment": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "issueId": "96179c34-d541-49af-b046-c06f0377732c", "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b", "body": "string", "created": "2019-08-24T14:15:22Z", "modified": "2019-08-24T14:15:22Z", "author": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "email": "string" }, "mentions": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "email": "string" } ], "can": { "update": true, "delete": true } }}List an issue's comments
Oldest first, with the author embedded for direct rendering.
Edit a comment (author-only)
Only the comment's author may edit it — anyone else in the org gets 403 ("only the author can edit a comment"), an administrator included. Unlike deleteComment there is deliberately NO moderator override here: removing someone's words is moderation, rewriting them under their own name is not. Editing sets the comment's modified timestamp (null until first edit — the "(edited)" marker).