Sign in

v4

OpenAPI 3.0.1Apache 2.02026-08-016169702.3 MB
Issues

Edit issue

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.

Note: This endpoint doesn't check screen configurations to determine if a field is editable. For more context, see the Deprecation of override screen security announcement.

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. Note that the description, environment, and any textarea type custom fields (multi-line text fields) take Atlassian Document Format content. Single line custom fields (textfield) accept a string and don't handle Atlassian Document Format content.

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:

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

Path parameters

issueIdOrKeystring required

The ID or key of the issue.

Query parameters

notifyUsersboolean

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.

overrideScreenSecurityboolean

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

overrideEditableFlagboolean

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

returnIssueboolean

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.

expandstring

The Get issue API expand parameter to use in the response if the returnIssue parameter is true.

Request body

fieldsobject

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.

updateobject

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.

Response

Returned if the request is successful and the returnIssue parameter is true

{"stackTrail":"paths:/rest/api/3/issue/{issueIdOrKey}:put:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}