Contact UsGet started
© 2024 Direct Cursus Technology L.L.C.

Editing an issue

Written by
Updated at May 6, 2024

Use this request to make changes to issues.

Warning

You can only change the issue status with the Status transition request.

Request format

Before making the request, get permission to access the API.

To edit an issue, use an HTTP PATCH request. Request parameters are provided in the request body in JSON format.

PATCH /v2/issues/<issue_ID_or_key>
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID: <organization ID>
{
   Request body in JSON format
}
Headers

  • Host

    Address of the node that provides the API:

    https://api.tracker.yandex.net

  • Authorization

    OAuth token in OAuth <OAuth_token> format, e.g.:

    OAuth 0c4181a7c2cf4521964a72ff********

  • X-Org-ID or X-Cloud-Org-ID

    Organization ID. You can find it out on the Tracker organizations page.

    • If a Yandex 360 for Business organization is the only one linked to Tracker, the X-Org-ID header is used.
    • If a Yandex Cloud Organization organization is the only one linked to Tracker, the X-Cloud-Org-ID header is used.
    • If both Yandex 360 for Business and Yandex Cloud Organization organizations are linked to Tracker at the same time, the X-Org-ID header and the Yandex 360 for Business organization ID are used.
Resource
Parameter Description Data type
<issue_key_or_ID> ID or key of the current issue. String
Request parameters

Additional parameters

Parameter Description Data type
version Issue version. Changes are only made to the current version of the issue. Number
Request body parameters

Additional parameters

Parameter Description Data type
summary Issue name. String
parent Parent issue. Object or string
description Issue description. String
sprint Block with information about sprints. Array of objects or strings
type Issue type Can be set as an object, a string (if the issue type key is provided), or a number (if the issue type ID is provided).
priority Issue priority Can be set as an object, a string (if the priority key is provided), or a number (if the priority ID is provided).
followers IDs or usernames of issue followers Array of objects or strings
attachmentIds Array of IDs of temporary files preloaded into Tracker. The listed files will be attached to the issue and displayed in the Attachments tab. Array of strings
descriptionAttachmentIds Array of IDs of temporary files preloaded into Tracker. The listed files will be attached to the issue and displayed in its description. Array of strings

parent object fields

Parameter Description Data type
id Parent issue ID String
key Parent issue key String

sprint object fields

Parameter Description Data type
id Sprint ID. You can get the sprint information using the request. Number

type object fields

Parameter Description Data type
id Issue type ID String
key Issue type key. String

priority object fields

Parameter Description Data type
id Priority ID String
key Priority key. String

followers object fields

Parameter Description Data type
id Employee ID String
Request body format

The request body includes a JSON object with the IDs of updated fields and their values.

Example 1: Changing the name, description, type, and priority of an issue.

  • An HTTP PATCH method is used.
  • We are editing the TEST-1 issue.
  • New issue type: Error.
  • New issue priority: Low.
PATCH /v2/issues/TEST-1
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID: <organization ID>

{
    "summary": "<new_issue_name>",
    "description": "<new_issue_description>",
    "type": {
        "id": "1",
        "key": "bug"
        },
    "priority": {
        "id": "2",
        "key": "minor"
        }
}

Example 2: Changing the parent issue, add it to sprints, and add followers.

  • An HTTP PATCH method is used.
  • We are editing the TEST-1 issue.
  • New parent issue: TEST-2.
  • The issue is added to sprints with ID 3 and ID 2. The sprints must be on different boards.
  • Followers added: userlogin-1 and userlogin-2.
PATCH /v2/issues/TEST-1
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID: <organization ID>

{
    "parent": {
        "key": "TEST-2"},
    "sprint": [{"id": "3"}, {"id": "2"}],
    "followers": {
        "add": ["userlogin-1", "userlogin-2"]
        }
}

Example 3: Attaching files to an issue description

  • An HTTP PATCH method is used.
  • We are editing the TEST-3 issue.
  • First, you should upload the temporary files and specify their IDs.
  • Temporary files will be attached to the issue description.
PATCH /v2/issues/TEST-3
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID: <organization ID>

{
    "descriptionAttachmentIds":[
       4512********,
       4514********
    ]
}

Response format

If the request is successful, the API returns a response with code 200 OK.

The response body contains information about the edited issue in JSON format.

[
    {
    "self": "https://https://api.tracker.yandex.net/v2/issues/TREK-9844",
    "id": "593cd211ef7e8a33********",
    "key": "TREK-9844",
    "version": 7,
    "lastCommentUpdatedAt": "2017-07-18T13:33:44.291+0000",
    "summary": "subtask",
    "parent": {
        "self": "https://https://api.tracker.yandex.net/v2/issues/JUNE-2",
        "id": "593cd0acef7e8a33********",
        "key": "JUNE-2",
        "display": "Task"
        },
    "aliases": [
            "JUNE-3"
        ],

    "updatedBy": {
        "self": "https://https://api.tracker.yandex.net/v2/users/11********",
        "id": "11********",
        "display": "Ivan Ivanov"
        },
    "description": "<#<html><head></head><body><div>test</div><div>&nbsp;</div><div>&nbsp;</div> </body></html>#>",
    "sprint": [
            {
        "self": "https://https://api.tracker.yandex.net/v2/sprints/53**",
        "id": "53**",
        "display": "sprint1"
            }
        ],
    "type": {
        "self": "https://https://api.tracker.yandex.net/v2/issuetypes/2",
        "id": "2",
        "key": "task",
        "display": "Issue"
        },
    "priority": {
        "self": "https://https://api.tracker.yandex.net/v2/priorities/2",
        "id": "2",
        "key": "normal",
        "display": "Normal"
        },

    "createdAt": "2017-06-11T05:16:01.339+0000",
    "followers": [
        {
        "self": "https://https://api.tracker.yandex.net/v2/users/11********",
        "id": "11********",
        "display": "Ivan Ivanov"
        }
        ],
    "createdBy": {
        "self": "https://https://api.tracker.yandex.net/v2/users/11********",
        "id": "11********",
        "display": "Ivan Ivanov"
        },
    "votes": 0,
    "assignee": {
        "self": "https://https://api.tracker.yandex.net/v2/users/11********",
        "id": "11********",
        "display": "Ivan Ivanov"
        },
    "project": {
        "display": "Startrek project",
        "id": "1",
        "self": "https://https://api.tracker.yandex.net/v2/projects/1"
    },
    "queue": {
        "self": "https://https://api.tracker.yandex.net/v2/queues/TREK",
        "id": "111",
        "key": "TREK",
        "display": "Startrek"
        },
    "updatedAt": "2017-07-18T13:33:44.291+0000",
    "status": {
        "self": "https://https://api.tracker.yandex.net/v2/statuses/1",
        "id": "1",
        "key": "open",
        "display": "Open"
        },
    "previousStatus": {
        "self": "https://https://api.tracker.yandex.net/v2/statuses/2",
        "id": "2",
        "key": "resolved",
        "display": "Resolved"
        },
    "favorite": false
    },
    {...}
]
Response parameters
Parameter Description Data type
self Address of the API resource with information about the issue. String
id Issue ID. String
key Issue key. String
version Issue version. Each change to the issue parameters increases its version number. Number
lastCommentUpdatedAt Date and time when the last comment was added. String
summary Issue name. String
parent Object with information about the parent issue. Object
aliases Array with information about alternative issue keys. Array of strings
updatedBy Object with information about the employee who edited the issue last. Object
description Issue description. String
sprint Array of objects with information about the sprint. Array of objects
type Object with information about the issue type. Object
priority Object with information about the priority. Object
createdAt Issue creation date and time. String
followers Array of objects with information about issue followers. Array of objects
createdBy Object with information about the user who created the issue. Object
votes Number of votes for the issue. Number
assignee Object with information about the issue's assignee. Object
project Object with information about the issue project. Object
queue Object with information about the issue queue. Object
updatedAt Date and time when the issue was last updated. String
status Object with information about the issue status. Object
previousStatus Object with information about the previous status of the issue. Object
favorite Favorite issue flag:
  • true: Issue added to favorites by the user.
  • false: Issue not added to favorites.
 Logical

parent object fields

Parameter Description Data type
self Address of the API resource with information about the issue. String
id Issue ID. String
key Issue key. String
display Issue name displayed. String

updatedBy object fields

Parameter Description Data type
self Address of the API resource with information about the user. String
id User ID. String
display User's name displayed. String

Array object fields sprint

Parameter Description Data type
self Address of the API resource with information about the sprint. String
id Sprint ID. String
display Sprint name displayed. String

Object fields type

Parameter Description Data type
self Address of the API resource with information about the issue type. String
id ID of the issue type. String
key Key of the issue type. String
display Issue type name displayed. String

Object fields priority

Parameter Description Data type
self Address of the API resource with information about the priority. String
id Priority ID. String
key Priority key. String
display Priority name displayed. String

followers array object fields

Parameter Description Data type
self Address of the API resource with information about the user. String
id User ID. String
display User's name displayed. String

createdBy object fields

Parameter Description Data type
self Address of the API resource with information about the user. String
id User ID. String
display User's name displayed. String

assignee object fields

Parameter Description Data type
self Address of the API resource with information about the user. String
id User ID. String
display User's name displayed. String

project object fields

Parameter Description Data type
self Address of the API resource with information about the project String
id Project ID String
display Project name displayed String

queue object fields

Parameter Description Data type
self Address of the API resource with information about the queue. String
id Queue ID. String
key Queue key. String
display Queue name displayed. String

status object fields

Parameter Description Data type
self Address of the API resource with information about the status. String
id Status ID. String
key Status key. String
display Status name displayed. String

previousStatus object fields

Parameter Description Data type
self Address of the API resource with information about the status. String
id Status ID. String
key Status key. String
display Status name displayed. String

If the request is processed incorrectly, the API returns a response with an error code:

401
The user isn't authorized. Make sure to perform the actions described in API access.
403
Insufficient rights to perform this action. You can check what rights you have in the Tracker interface. The same rights are required to perform an action via the API and interface.
404
The requested object was not found. You may have specified an invalid object ID or key.
409
There was a conflict when editing the object. The error may be due to an invalid update version.
Previous
Getting issue parameters
Next
Creating an issue