Editing a column
Use this request to edit column parameters.
Request format
Before making a request, get permission to access the API.
To edit column parameters, use an HTTP PATCH request. Request parameters are provided in the request body in JSON format.
PATCH /v2/boards/<board_ID>/columns/<column_ID>
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID: <organization ID>
If-Match: "<version_number>"
<new_column_parameters_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. If you only have a Yandex Cloud Organization organization, use the
X-Cloud-Org-IDheader; if only Yandex 360 for Business or both organization types, useX-Org-ID. -
If-Match
Number of the current board version. If you specify an obsolete version of the board, the HTTP request returns an error message saying
412 Precondition Failed.
Resource
| Parameter | Description | Data type |
|---|---|---|
| <board_ID> | Board ID | Number |
| <column_ID> | Column ID | Number |
Request body parameters
The request body contains the column parameters to be changed.
Additional parameters
| Parameter | Description | Data type |
|---|---|---|
| name | Column name | String |
| statuses | The array contains the keys of possible statuses of issues to be included in the column. The list of all issue statuses: https://tracker.yandex.com/admin/statuses |
Array |
Example: Edit the parameters of the column with ID
1on the board with ID5.
- An HTTP
POSTmethod is used.PATCH /v2/boards/5/columns/1 Host: https://api.tracker.yandex.net Authorization: OAuth <OAuth_token> X-Org-ID or X-Cloud-Org-ID: <organization_ID> If-Match: "<version_number>" { "name": "Approve", "statuses": [ "needInfo", "needAcceptance" ] }Note
If you only have a Yandex Cloud Organization organization, use the
X-Cloud-Org-IDheader; if only Yandex 360 for Business or both organization types, useX-Org-ID.
Response format
If the request is successful, the API returns a response with code 200 OK.
The response body contains a JSON object with all column parameters, including the updated ones.
{
"self": "https://https://api.tracker.yandex.net/v2/boards/73/columns/5",
"id": 5,
"name": "Approve",
"statuses":
[
{
"self": "https://https://api.tracker.yandex.net/v2/statuses/2",
"id": "2",
"key": "needInfo",
"display": "Need info"
},
...
]
}
Response parameters
| Parameter | Description | Data type |
|---|---|---|
| self | Address of the API resource with information about the board column | String |
| id | Column ID | Number |
| name | Column name | String |
| statuses | Array with the statuses of the issues included in the column | Array |
statuses 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:
- 400
- One or more request parameters have an invalid value.
- 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.
- 412
- There was a conflict when editing the object. The error may be due to an invalid update version.
- 422
- JSON validation error, the request is rejected.
- 428
- Access to the resource is denied. Make sure all required conditions for the request are specified.
- 500
- Internal service error. Try resending your request in a few minutes.
- 503
- The API service is temporarily unavailable.