PUT /rest/api/2/issue/{issueIdOrKey}

Edits an issue. Issue properties may be updated as part of the edit. Please note that issue transition is not supported and is ignored here. To transition an issue, please use Transition issue.

The edits to the issue's fields are defined using update and fields. The fields that can be edited are determined using Get edit issue metadata.

The parent field may be set by key or ID. For standard issue types, the parent may be removed by setting update.parent.set.none to true.

Connect apps having an app user with Administer Jira global permission, and Forge apps acting on behalf of users with Administer Jira global permission, can override the screen security configuration using overrideScreenSecurity and overrideEditableFlag.

This operation can be accessed anonymously.

Permissions required:

Browse projects and Edit issues project permission for the project that the issue is in.
If issue-level security is configured, issue-level security permission to view the issue.

Servers

https://your-domain.atlassian.net

Path parameters

Name	Type	Required	Description
`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 a notification email about the issue update is sent to all watchers. To disable the notification, administer Jira or administer project permissions are required. If the user doesn't have the necessary permission the request is ignored. Default value: true
`overrideScreenSecurity`	Boolean	No	Whether screen security is overridden to enable hidden fields to be edited. Available to Connect app users with Administer Jira global permission and Forge apps acting on behalf of users with Administer Jira global permission. Default value: false
`expand`	String	No	The Get issue API expand parameter to use in the response if the `returnIssue` parameter is `true`.
`overrideEditableFlag`	Boolean	No	Whether screen security is overridden to enable uneditable fields to be edited. Available to Connect app users with Administer Jira global permission and Forge apps acting on behalf of users with Administer Jira global permission. Default value: false
`returnIssue`	Boolean	No	Whether the response should contain the issue with fields edited in this request. The returned issue will have the same format as in the Get issue API. Default value: false

Request body fields

Name	Type	Required	Description
`properties[]`	Array	No	Details of issue properties to be add or 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.
`fields`	Object	No	List of issue screen fields to update, specifying the sub-field to update and its value for each field. This field provides a straightforward option when setting a sub-field. When multiple sub-fields or other operations are required, use `update`. Fields included in here cannot be included in `update`.
`update`	Object	No	A Map containing the field field name and a list of operations to perform on the issue screen field. Note that fields included in here cannot be included in `fields`.
`update.name`	Object	No	Details of an operation to perform on a field.
`update.name.edit`		No	The value to edit in the field.
`update.name.remove`		No	The value to removed from the field.
`update.name.copy`		No	The field value to copy from another issue.
`update.name.set`		No	The value to set in the field.
`update.name.add`		No	The value to add to the field.

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.