Editing an issue type

Use this request to modify an existing issue type.

PATCH

https://api.tracker.yandex.net/v3/issuetypes/<issue_type_ID_or_key>?version=<issue_type_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 type, use an HTTP PATCH request. In the request body, specify the parameters in JSON format.

PATCH /v3/issuetypes/<issue_type_ID_or_key>?version=<issue_type_version>
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth token>
X-Org-ID or X-Cloud-Org-ID: <organization_ID>

{
    "name": {
        "ru": "Покупатель",
        "en": "Customer"
    }
}

To get the issue type parameters like id, key, or version, use the Get a list of issue types 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
issue_type_ID_or_key Unique ID of the issue type in Yandex Tracker, or the issue type key. Number or string
Request parameters

Additional parameters

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

Additional parameters

Parameter Description Data type
name Issue type name. String

Example: Changing an issue type name.

  • An HTTP PATCH method is used.
  • Let's edit the issue type with id = 23.
  • New issue type name: "Customer".
PATCH /v3/issuetypes/23?version=1
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth token>
X-Org-ID or X-Cloud-Org-ID: <organization_ID>

[
    {
        "name": {
            "ru": "Покупатель",
            "en": "Customer"
        }
    }
]

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

[
    {
        "self": "https://api.tracker.yandex.net/v3/issuetypes/23",
        "id": 23,
        "version": 2,
        "key": "client",
        "name": "Customer"
    }
]
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 type in Yandex Tracker Number
version Version of the issue type Number
key Key of the issue type String
name Issue type name 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 type
Next
Getting a list of statuses