---
metadata:
  - name: generator
    content: Diplodoc Platform v5.54.5
  - property: og:type
    content: article
  - property: article:section
    content: Справочник API
  - property: og:title
    content: Редактировать колонку
  - property: article:tag
    content: Техническая инструкция
alternate:
  - https://yandex.ru/support/tracker/en/api-ref/boards/patch-column.md
  - https://yandex.ru/support/tracker/ru/api-ref/boards/patch-column.md
  - href: ru/api-ref/boards/patch-column.md
    type: text/markdown
    title: Markdown version
  - href: ../../llms.txt
    type: text/markdown
    title: llms.txt
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/support/tracker/ru/llms.txt


# Редактировать колонку

Запрос позволяет изменить параметры колонки.

<div class="request_example method_patch yfm-clipboard">
    <p>PATCH</p>
    <pre><code>https://api.tracker.yandex.net/v3/boards/&lt;id_доски>/columns/&lt;id_колонки></code></pre>
    <button class="yfm-clipboard-button"><svg width="16" height="16" viewBox="0 0 24 24" class="yfm-clipboard-icon" data-animation="15">
    <path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path>
    <path stroke="currentColor" fill="transparent" strokewidth="1.5" d="M9.5 13l3 3l5 -5" visibility="hidden">
        <animate id="visibileAnimation-15" attributeName="visibility" from="hidden" to="visible" dur="0.2s" fill="freeze" begin=""></animate>
        <animate id="hideAnimation-15" attributeName="visibility" from="visible" to="hidden" dur="1s" begin="visibileAnimation-15.end+1" fill="freeze"></animate>
    </path>
</svg>
</button>
</div>

<!-- source: ru/api-ref/_assets/style/methods.md -->

<!-- endsource: ru/api-ref/_assets/style/methods.md -->

## Формат запроса {#query}

Перед выполнением запроса [получите доступ к API](https://yandex.ru/support/tracker/ru/api-ref/access.md).

Чтобы изменить параметры колонки, используйте HTTP-запрос с методом `PATCH`. В теле запроса укажите параметры в формате JSON.

```
PATCH /v3/boards/<id_доски>/columns/<id_колонки>
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
Content-Type: application/json
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>
If-Match: "<номер_версии>"

<новые_параметры_колонки_в_формате_JSON>
```

{% cut "Заголовки" %}

- `Host`: адрес узла, предоставляющего API

- <!-- source: ru/api-ref/_includes/authorization.md -->
  `Authorization`: токен для авторизации в одном из форматов:

    - `OAuth <OAuth-токен>` при авторизации по протоколу OAuth 2.0. [Читать подробнее](https://yandex.ru/support/tracker/ru/api-ref/access.md#about_OAuth)

    - `Bearer <IAM-токен>` при авторизации с помощью IAM-токена — если к Трекеру привязана организация Yandex Identity Hub. [Читать подробнее](https://yandex.ru/support/tracker/ru/api-ref/access.md#iam-token)
  <!-- endsource: ru/api-ref/_includes/authorization.md -->

- <!-- source: ru/api-ref/_includes/content-type-json.md -->
  `Content-Type`: формат тела запроса. Должен иметь значение `application/json`.
  <!-- endsource: ru/api-ref/_includes/content-type-json.md -->


- <!-- source: ru/api-ref/_includes/org-id.md -->
  `X-Org-ID` или `X-Cloud-Org-ID`: идентификатор организации.

  - если к Трекеру привязана организация Яндекс 360 для бизнеса, используйте заголовок `X-Org-ID`,

  - если к Трекеру привязана организация Yandex Identity Hub, используйте заголовок `X-Cloud-Org-ID`.
  <!-- endsource: ru/api-ref/_includes/org-id.md -->

  <!-- source: ru/api-ref/_includes/org-id.md -->
  Чтобы узнать идентификатор организации, перейдите на страницу **Администрирование** → [**Организации**](https://tracker.yandex.ru/admin/orgs) и скопируйте значение поля **идентификатор**.
  <!-- endsource: ru/api-ref/_includes/org-id.md -->


- `If-Match`: номер текущей версии доски. При указании неактуальной версии доски в ответ на HTTP-запрос придет ответ с ошибкой `412 Precondition Failed`.

{% endcut %}

{% cut "Ресурс" %}

Параметр | Описание | Тип данных
----- | ----- | -----
\<id_доски\> | Идентификатор доски | Число
\<id_колонки\> | Идентификатор колонки | Число

{% endcut %}

{% cut "Параметры тела запроса" %}

Тело запроса содержит параметры колонки, которые нужно изменить.

**Дополнительные параметры**

Параметр | Описание | Тип данных
-------- | -------- | ----------
name | Название колонки. | Строка
statuses | Массив содержит ключи возможных статусов задач, которые попадут в колонку.<br/>Список всех статусов задачи: [https://tracker.yandex.ru/admin/statuses](https://tracker.yandex.ru/admin/statuses) | Массив

{% endcut %}

> Пример: Изменить параметры колонки с идентификатором `1` на доске с идентификатором `5`.
>
> ```json translate=no
> PATCH /v3/boards/5/columns/1
> Host: api.tracker.yandex.net
> Authorization: OAuth y0__xAbc******
> Content-Type: application/json
> X-Org-ID: 1234******
> If-Match: "<номер_версии>"
>
> {
>   "name": "Approve",
>   "statuses":
>       [
>         "needInfo", "needAcceptance"
>       ]
> }
> ```

## Формат ответа {#answer}

{% list tabs %}

- Запрос выполнен успешно

    <!-- source: ru/api-ref/_includes/answer-200.md -->
    В случае успешного выполнения запроса API возвращает ответ с кодом `200 OK`.
    <!-- endsource: ru/api-ref/_includes/answer-200.md -->

    Тело ответа содержит JSON-объект со всеми параметрами колонки, включая измененные.

    ```json translate=no
    {
        "self": "https://api.tracker.yandex.net/v3/boards/73/columns/5",
        "id": 5,
        "name": "Pause",
        "statuses":
         [
            {
               "self": "https://api.tracker.yandex.net/v3/statuses/2",
               "id": "2",
               "key": "needInfo",
               "display": "Требуется информация"
            },
             ...
          ]
    }
    ```

    {% cut "Параметры ответа" %}

    Параметр | Описание | Тип данных
    -------- | -------- | ----------
    self | Адрес ресурса API, который содержит информацию о колонке доски | Строка
    id | Идентификатор колонки | Число
    name | Название колонки | Строка
    [statuses](#statuses) | Массив содержит информацию о статусах задач, которые находятся в колонке | Массив

    **Поля объекта** `statuses` {#statuses}

    <!-- source: ru/api-ref/_includes/status.md -->
    Параметр | Описание | Тип данных
    ----- | ----- | -----
    self | Адрес ресурса API, который содержит информацию о статусе. | Строка
    id | Идентификатор статуса. | Строка
    key | Ключ статуса. | Строка
    display | Отображаемое название статуса. | Строка
    <!-- endsource: ru/api-ref/_includes/status.md -->

    {% endcut %}

- Запрос выполнен с ошибкой

    Если запрос не был успешно обработан, API возвращает ответ с кодом ошибки:

    <!-- source: ru/api-ref/_includes/answer-error-400.md -->
    400
    :   Один или несколько параметров запроса имеют недопустимое значение.
    <!-- endsource: ru/api-ref/_includes/answer-error-400.md -->

    <!-- source: ru/api-ref/_includes/answer-error-403.md -->
    403
    :   У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Трекера — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.
    <!-- endsource: ru/api-ref/_includes/answer-error-403.md -->

    <!-- source: ru/api-ref/_includes/answer-error-404.md -->
    404
    :   Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.
    <!-- endsource: ru/api-ref/_includes/answer-error-404.md -->

    <!-- source: ru/api-ref/_includes/answer-error-412.md -->
    412
    :   При редактировании объекта возник конфликт. Возможно, ошибка возникла из-за неправильно указанной версии изменений. 
    <!-- endsource: ru/api-ref/_includes/answer-error-412.md -->

    <!-- source: ru/api-ref/_includes/answer-error-422.md -->
    422 
    :   Ошибка валидации JSON, запрос отклонен.
    <!-- endsource: ru/api-ref/_includes/answer-error-422.md -->

    <!-- source: ru/api-ref/_includes/answer-error-428.md -->
    428
    :   Доступ к ресурсу отклонен. Проверьте, указаны ли все обязательные условия выполнения запроса. 
    <!-- endsource: ru/api-ref/_includes/answer-error-428.md -->

    <!-- source: ru/api-ref/_includes/answer-error-500.md -->
    500
    :   Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.
    <!-- endsource: ru/api-ref/_includes/answer-error-500.md -->

    <!-- source: ru/api-ref/_includes/answer-error-503.md -->
    503
    :   Сервис API временно недоступен.    
    <!-- endsource: ru/api-ref/_includes/answer-error-503.md -->

{% endlist %}
