Update comment - JIRA 7.6.1

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.

curl --location --request PUT 'http://jira.local:8080/jira/rest//rest/api/3/issue//comment/' \ --header 'Content-Type: application/json' \ --data-raw '{ "body": { "content": [ { "content": [ { "text": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper.", "type": "text" } ], "type": "paragraph" } ], "type": "doc", "version": 1 }, "visibility": { "identifier": "Administrators", "type": "role", "value": "Administrators" } }'

{ "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000", "id": "10000", "author": { "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g", "accountId": "5b10a2844c20165700ede21g", "displayName": "Mia Krystof", "active": false }, "body": { "type": "doc", "version": 1, "content": [ { "type": "paragraph", "content": [ { "type": "text", "text": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper." } ] } ] }, "updateAuthor": { "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g", "accountId": "5b10a2844c20165700ede21g", "displayName": "Mia Krystof", "active": false }, "created": "2021-01-17T12:34:00.000+0000", "updated": "2021-01-18T23:45:00.000+0000", "visibility": { "type": "role", "value": "Administrators", "identifier": "Administrators" } }

Request

Path Params

issueIdOrKey

string

required

The ID or key of the issue.

string

required

The ID of the comment.

Query Params

notifyUsers

string

optional

Whether users are notified when a comment is updated.

overrideEditableFlag

string

optional

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.

expand

string

optional

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

Body Params application/json

A comment.

body

optional

The comment text in Atlassian Document Format.

properties

array[object (EntityProperty) {2}]

optional

A list of comment properties. Optional on create and update.

key

string

optional

The key of the property. Required on create and update.

value

optional

The value of the property. Required on create and update.

visibility

object

optional

The group or role to which this comment is visible. Optional on create and update.

identifier

string | null

optional

The ID of the group or the name of the role that visibility of this item is restricted to.

type

enum<string>

optional

Whether visibility of this item is restricted to a group or role.

Allowed values:

grouprole

value

string

optional

The name of the group or role that visibility of this item is restricted to. Please note that the name of a group is mutable, to reliably identify a group use identifier.

Additional properties

integer | number | string | boolean

optional

Additional properties

integer | number | string | boolean

optional

Examples

Responses

🟢200Returned if the request is successful.

application/json

Body

A comment.

author

object

read-onlyoptional

The ID of the user who created the comment.

body

optional

The comment text in Atlassian Document Format.

created

string <date-time>

read-onlyoptional

The date and time at which the comment was created.

string

read-onlyoptional

The ID of the comment.

jsdAuthorCanSeeRequest

boolean

read-onlyoptional

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.

jsdPublic

boolean

read-onlyoptional

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.

properties

array[object (EntityProperty) {2}]

optional

A list of comment properties. Optional on create and update.

key

string

optional

The key of the property. Required on create and update.

value

optional

The value of the property. Required on create and update.

renderedBody

string

read-onlyoptional

The rendered version of the comment.

self

string

read-onlyoptional

The URL of the comment.

updateAuthor

object

read-onlyoptional

The ID of the user who updated the comment last.

updated

string <date-time>

read-onlyoptional

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

visibility

object

optional

The group or role to which this comment is visible. Optional on create and update.

identifier

string | null

optional

The ID of the group or the name of the role that visibility of this item is restricted to.

type

enum<string>

optional

Whether visibility of this item is restricted to a group or role.

Allowed values:

grouprole

value

string

optional

The name of the group or role that visibility of this item is restricted to. Please note that the name of a group is mutable, to reliably identify a group use identifier.

Additional properties

integer | number | string | boolean

optional

Additional properties

integer | number | string | boolean

optional

🟠400Returned if the user does not have permission to edit the comment or the request is invalid.

🟠401Returned if the authentication credentials are incorrect or missing.

🟠404Returned if the issue or comment is not found or the user does not have permission to view the issue or comment.