Edit issue - JIRA 7.6.1

Edits an issue. A transition may be applied and issue properties updated as part of the edit.

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

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.

curl --location --request PUT 'http://jira.local:8080/jira/rest//rest/api/3/issue/' \ --header 'Content-Type: application/json' \ --data-raw '{ "fields": { "customfield_10000": { "content": [ { "content": [ { "text": "Investigation underway", "type": "text" } ], "type": "paragraph" } ], "type": "doc", "version": 1 }, "customfield_10010": 1, "summary": "Completed orders still displaying in pending" }, "historyMetadata": { "activityDescription": "Complete order processing", "actor": { "avatarUrl": "http://mysystem/avatar/tony.jpg", "displayName": "Tony", "id": "tony", "type": "mysystem-user", "url": "http://mysystem/users/tony" }, "cause": { "id": "myevent", "type": "mysystem-event" }, "description": "From the order testing process", "extraData": { "Iteration": "10a", "Step": "4" }, "generator": { "id": "mysystem-1", "type": "mysystem-application" }, "type": "myplugin:type" }, "properties": [ { "key": "key1", "value": "Order number 10784" }, { "key": "key2", "value": "Order number 10923" } ], "update": { "components": [ { "set": "" } ], "labels": [ { "add": "triaged" }, { "remove": "blocker" } ], "summary": [ { "set": "Bug in business logic" } ], "timetracking": [ { "edit": { "originalEstimate": "1w 1d", "remainingEstimate": "4d" } } ] } }'

Request

Path Params

issueIdOrKey

string

required

The ID or key of the issue.

Query Params

notifyUsers

string

optional

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.

overrideScreenSecurity

string

optional

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.

overrideEditableFlag

string

optional

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.

Body Params application/json

Details of an issue update request.

fields

object

optional

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.

Additional properties

integer | number | string | boolean

optional

historyMetadata

object

optional

Additional issue history details.

activityDescription

string

optional

The activity described in the history record.

activityDescriptionKey

string

optional

The key of the activity described in the history record.

actor

object

optional

Details of the user whose action created the history record.

cause

object

optional

Details of the cause that triggered the creation the history record.

description

string

optional

The description of the history record.

descriptionKey

string

optional

The description key of the history record.

emailDescription

string

optional

The description of the email address associated the history record.

emailDescriptionKey

string

optional

The description key of the email address associated the history record.

extraData

object

optional

Additional arbitrary information about the history record.

generator

object

optional

Details of the system that generated the history record.

type

string

optional

The type of the history record.

Additional properties

integer | number | string | boolean

optional

properties

array[object (EntityProperty) {2}]

optional

Details of issue properties to be add or 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.

transition

object

optional

Details of a transition. Required when performing a transition, optional when creating or editing an issue.

string

optional

The ID of the issue transition. Required when specifying a transition to undertake.

looped

boolean

optional

Additional properties

integer | number | string | boolean

optional

update

object

optional

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.

Additional properties

array[object (FieldUpdateOperation) {5}]

optional

Additional properties

integer | number | string | boolean

optional

Examples

Responses

🟢204Returned if the request is successful.

application/json

Body

No schema defined

🟠400Returned if: * the request body is missing. * the user does not have the necessary permission to edit one or more fields. * the request includes one or more fields that are not found or are not associated with the issue's edit screen. * the reque

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

🟠403Returned if the user uses `overrideScreenSecurity` or `overrideEditableFlag` but doesn't have the necessary permission.

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