PUT /rest/api/2/issue/{issueIdOrKey}/comment/{id}
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 commentsproject 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.
Servers
- https://your-domain.atlassian.net
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | Yes |
The ID of the comment. |
issueIdOrKey |
String | Yes |
The ID or key of the issue. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
notifyUsers |
Boolean | No |
Whether users are notified when a comment is updated. Default value: true |
expand |
String | No |
Use expand to include additional information about comments in the response. This parameter accepts |
overrideEditableFlag |
Boolean | No |
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. Default value: false |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | No |
The ID of the comment. |
jsdAuthorCanSeeRequest |
Boolean | No |
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. |
created |
String | No |
The date and time at which the comment was created. |
self |
String | No |
The URL of the comment. |
properties[] |
Array | No |
A list of comment properties. Optional on create and update. |
properties[].key |
String | No |
The key of the property. Required on create and update. |
properties[].value |
No |
The value of the property. Required on create and update. |
|
updated |
String | No |
The date and time at which the comment was updated last. |
jsdPublic |
Boolean | No |
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. |
body |
String | No |
The comment text. |
renderedBody |
String | No |
The rendered version of the comment. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.