Creating an issue status

Use this request to create a new issue status.

POST

https://api.tracker.yandex.net/v3/statuses/

You need Administrator rights to run this request.

Query format

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

To create an issue status, make an HTTP POST request. In the request body, specify the parameters in JSON format:

POST /v3/statuses/
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth token>
X-Org-ID or X-Cloud-Org-ID: <organization_ID>

{
    "key": "myStatus",
    "name": {
        "ru": "Мой статус",
        "en": "My status"
    },
    "type": "paused"
}
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.

Request body parameters

The request body contains the information needed to create a new status:

Required parameters

Parameter Description Data type
key Status key (ID). Use Latin characters only, starting with a lowercase letter. String
name Status name Map object
type Status type. Acceptable values include:
  • new
  • inProgress
  • paused
  • done
  • cancelled
 String

Fields of the name object

Parameter Description Data type
ru Status name in Russian String
en Status name in English String

Response format

If the request is successful, the API returns a response with code 201 Created.

The response body contains information about the created status in JSON format.

[
    {
        "self": "https://api.tracker.yandex.net/v3/statuses/29",
        "id": 29,
        "version": 1,
        "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 String
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 a list of statuses
Next
Editing an issue status