Editing an issue status

Use this request to change an issue status.

PATCH

https://api.tracker.yandex.net/v3/statuses/<status_ID_or_key>?version=<status_version>

You need Administrator rights to run this request.

Query format

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

To edit an issue status, make an HTTP request using the PATCH method. In the request body, specify the parameters in JSON format.

PATCH /v3/statuses/<status_ID_or_key>?version=<status_version>
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth token>
X-Org-ID or X-Cloud-Org-ID: <organization_ID>
{
    "name": {
        "ru": "Мой статус",
        "en": "My status"
    },
    "description": "My status description",
    "order": 350
}

To retrieve issue status parameters such as id, key, or version, use the Get a list of statuses request.

Headers

  • Host: Address of the node that provides the API.

  • Authorization: Authorization token about these formats:

    • OAuth <OAuth_token>: For authorization using the OAuth 2.0 protocol. Learn more

    • Bearer <IAM_token>: For authorization using an IAM token, if a Yandex Cloud Organization organization is linked to Tracker. Learn more

  • X-Org-ID or X-Cloud-Org-ID: Organization ID.

    • Use the X-Org-ID header if a Tracker organization is linked to Yandex 360 for Business.

    • Use the X-Cloud-Org-ID header if a Tracker organization is linked to Yandex Cloud Organization.

    To get the organization ID, go to Administration → Organizations and copy the value from the ID field.

Resource
Parameter Description Data type
status_ID_or_key Unique ID of the issue status in Yandex Tracker, or the status key. View the list of statuses on the [{{ link-admin-statuses }}]({{ link-admin-statuses }}) page Number or string
Request parameters

Additional parameters

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

Additional parameters

Parameter Description Data type
name Status name. String
description Status description. String
order Status weight. This parameter affects the order of status display in the interface. Number
type Status type. Acceptable values include:
  • new
  • inProgress
  • paused
  • done
  • cancelled
 String

Example: Changing the name of the issue status.

  • An HTTP PATCH method is used.
  • Editing status with id = 29.
  • New issue status name: "On pause".
PATCH /v3/statuses/29?version=1
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth token>
X-Org-ID or X-Cloud-Org-ID: <organization_ID>

{
    "name": {
        "ru": "Приостановлен",
        "en": "On pause"
        },
    "description": "Issue is paused"
}

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 status in JSON format.

[
    {
        "self": "https://api.tracker.yandex.net/v3/statuses/29",
        "id": 29,
        "version": 2,
        "key": "pause",
        "name": "On pause",
        "description": "Issue is paused",
        "order": 350,
        "type": "paused"
    }
]
Response parameters
Parameter Description Data type
self Address of the API resource with information about the issue type String
id Unique ID of the issue status in Yandex Tracker Number
version Version of the issue status Number
key Status key String
name Status name String
description Status description String
order Status weight. This parameter affects the order of status display in the interface Number
type Status type. Acceptable values include:
  • new
  • inProgress
  • paused
  • done
  • cancelled
 String

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

401
The user is not authorized. Make sure that actions described in the API access section are performed.
403
You are not authorized 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.
423
Object edits disabled. The version parameter value limit (the maximum number of object updates) might have been exceeded. The maximum version value is 10100 for robots and 11100 for users.
Previous
Creating an issue status
Next
Getting a list of resolutions