Issue comments

Add comment

Changed on

Adds a comment to an issue.

This operation can be accessed anonymously.

Permissions required:

  • Browse projects and Add comments 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.
post/rest/api/3/issue/{issueIdOrKey}/comment

Request

  • Base URL
    https://your-domain.atlassian.net
  • URL
    https://your-domain.atlassian.net/rest/api/3/issue/{issueIdOrKey}/comment
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://auth.atlassian.com/authorize
      Token URL: https://auth.atlassian.com/oauth/token scopes: write:jira-work
    • or none

Path parameters

issueIdOrKeystring required

The ID or key of the issue.

Query parameters

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

bodyunknown
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.

bodyunknown
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.

Changes