Sign in

v4

OpenAPI 3.0.1Apache 2.02026-08-016169702.3 MB
Issue comments

Update comment

Updates a comment.

This operation can be accessed anonymously.

Permissions required:

  • Browse projects project permission for the project that the issue containing the comment is in.
  • If issue-level security is configured, issue-level security permission to view the issue.
  • Edit all comments project permission to update any comment or Edit own comments to update comment created by the user.
  • If the comment has visibility restrictions, the user belongs to the group or has the role visibility is restricted to.

WARNING: Child comments inherit visibility from their parent comment. Attempting to update a child comment's visibility will result in a 400 (Bad Request) error.

put/rest/api/3/issue/{issueIdOrKey}/comment/{id}

Path parameters

issueIdOrKeystring required

The ID or key of the issue.

idstring required

The ID of the comment.

Query parameters

notifyUsersboolean

Whether users are notified when a comment is updated.

overrideEditableFlagboolean

Whether screen security is overridden to enable uneditable fields to be edited. Available to Connect app users with the Administer Jira global permission and Forge apps acting on behalf of users with Administer Jira global permission.

expandstring

Use expand to include additional information about comments in the response. This parameter accepts renderedBody, which returns the comment body rendered in HTML.

Request body

{"stackTrail":"components:schemas:Comment:properties:body","oasType":"schema","type":"unknown","description":"The comment text in [Atlassian Document Format](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/)."}
createdstring date-time

The date and time at which the comment was created.

idstring

The ID of the comment.

jsdAuthorCanSeeRequestboolean

Whether the comment was added from an email sent by a person who is not part of the issue. See Allow external emails to be added as comments on issuesfor information on setting up this feature.

jsdPublicboolean

Whether the comment is visible in Jira Service Desk. Defaults to true when comments are created in the Jira Cloud Platform. This includes when the site doesn't use Jira Service Desk or the project isn't a Jira Service Desk project and, therefore, there is no Jira Service Desk for the issue to be visible on. To create a comment with its visibility in Jira Service Desk set to false, use the Jira Service Desk REST API Create request comment operation.

renderedBodystring

The rendered version of the comment.

selfstring

The URL of the comment.

updatedstring date-time

The date and time at which the comment was updated last.

Response

Returned if the request is successful.

{"stackTrail":"components:schemas:Comment:properties:body","oasType":"schema","type":"unknown","description":"The comment text in [Atlassian Document Format](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/)."}
createdstring date-time

The date and time at which the comment was created.

idstring

The ID of the comment.

jsdAuthorCanSeeRequestboolean

Whether the comment was added from an email sent by a person who is not part of the issue. See Allow external emails to be added as comments on issuesfor information on setting up this feature.

jsdPublicboolean

Whether the comment is visible in Jira Service Desk. Defaults to true when comments are created in the Jira Cloud Platform. This includes when the site doesn't use Jira Service Desk or the project isn't a Jira Service Desk project and, therefore, there is no Jira Service Desk for the issue to be visible on. To create a comment with its visibility in Jira Service Desk set to false, use the Jira Service Desk REST API Create request comment operation.

renderedBodystring

The rendered version of the comment.

selfstring

The URL of the comment.

updatedstring date-time

The date and time at which the comment was updated last.