---
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-board.md
  - https://yandex.ru/support/tracker/ru/api-ref/boards/patch-board.md
  - href: ru/api-ref/boards/patch-board.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


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

Запрос позволяет изменить параметры [доски задач](*board).

<div class="request_example method_patch yfm-clipboard">
    <p>PATCH</p>
    <pre><code>https://api.tracker.yandex.net/v3/boards/&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.

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

{
  "name": "New name",
  "nonParametrizedColumns": [
    {
      "name": "To Do"
    },
    {
      "name": "In Progress"
    }
  ]
}
```

<!-- source: ru/api-ref/_includes/headings.md -->
{% 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 -->


{% endcut %}
<!-- endsource: ru/api-ref/_includes/headings.md -->

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

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

{% endcut %}

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

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

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

{% note warning %}

Владельца доски (параметр `owner`) через API-запрос изменить нельзя.

{% endnote %}

#|
|| Параметр | Описание | Тип данных ||
|| name | Название доски | Строка ||
|| backlogAvailable
sprintsAvailable
| Опции для включения бэклога и спринтов на доске задач:
* Если оба параметра одновременно имеют значение `true`, бэклог и спринты включены
* Если оба параметра одновременно имеют значение `false`, бэклог и спринты отключены

[Что такое бэклог и спринты](https://yandex.ru/support/tracker/manager/boards-instruments.html) | Логический ||
|| [columns](#cols) | Перечисление колонок доски | Массив объектов ||
|| [backlogColumns](#backlog-cols) | Перечисление дополнительных колонок в бэклоге. [Что такое колонки в бэклоге](https://yandex.ru/support/tracker/manager/backlog.html#columns) | Массив объектов ||
|| [nonParametrizedColumns](#nonparam-cols) | Перечисление произвольных колонок, не привязанных к статусам задач. [Что такое произвольные колонки](https://yandex.ru/support/tracker/manager/agile-columns.html#user-columns)| Массив объектов ||
|#

**Поля объекта** `columns` {#cols}
Параметр | Описание | Тип данных
-------- | -------- | ----------
name | Название колонки | Строка
statuses | Список статусов, задачи которых отображаются в колонке<br/>Имена и ключи статусов можно посмотреть на странице [Настройки Трекера](https://tracker.yandex.ru/admin/statuses) | Массив строк или чисел
limit | Предельное количество задач в колонке | Число

**Поля объекта** `backlogColumns` {#backlog-cols}
Параметр | Описание | Тип данных
-------- | -------- | ----------
name | Название колонки в бэклоге | Строка
limit | Предельное количество задач в колонке | Число

**Поля объекта** `nonParametrizedColumns` {#nonparam-cols}
Параметр | Описание | Тип данных
-------- | -------- | ----------
name | Название колонки | Строка
limit | Предельное количество задач в колонке | Число


{% endcut %}

> Пример: Изменить параметры доски с идентификатором `5`:
> * Настроить две колонки со статусами `open` и `closed`;
> * Отключить бэклог и спринты.
>
> ```json translate=no
> PATCH /v3/boards/5
> Host: api.tracker.yandex.net
> Authorization: OAuth y0__xAbc******
> Content-Type: application/json
> X-Org-ID: 1234******
>
> {
>  "name": "Testing new",
>  "columns": [
>    {
>      "name": "Open",
>      "statuses": "open"
>    },
>    {
>      "name": "Closed",
>      "statuses": "closed"
>    }
>  ],
>  "backlogAvailable": false,
>  "sprintsAvailable": false
> }
> ```

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

{% list tabs %}

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

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

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

    <!-- source: ru/api-ref/_includes/board-fields.md -->
    ```json translate=no
    {
        "self": "https://api.tracker.yandex.net/v3/boards/1",
        "id": 1,
        "version": 1,
        "name": "My board",
        "createdAt": "2026-01-22T09:02:18.647+0000",
        "updatedAt": "2026-01-22T09:02:18.647+0000",
        "createdBy": {
            "self": "https://api.tracker.yandex.net/v3/users/112000***",
            "id": "username",
            "display": "Имя Фамилия",
            "cloudUid": "ajevuhegoggfk*******",
            "passportUid": 112000***
        },
        "columns": [
          {
            "self": "https://api.tracker.yandex.net/v3/boards/1/columns/1",
            "id": "1",
            "display": "Открыт"
          },
          ...
        ],
        "useRanking": false,
        "estimateBy": {
            "self": "https://api.tracker.yandex.net/v3/fields/storyPoints",
            "id": "storyPoints",
            "display": "Story Points"
        },
        "country": {
            "self": "https://api.tracker.yandex.net/v3/countries/1",
            "id": "1",
            "display": "Россия"
        },
        "calendar": {
            "id": 6
        }
    }
    ```
    <!-- endsource: ru/api-ref/_includes/board-fields.md -->

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

    #|
    || Параметр | Описание | Тип данных ||
    || self | Адрес ресурса API, который содержит параметры доски | Строка ||
    || id | Идентификатор доски | Число ||
    || version | Версия доски. Каждое изменение доски увеличивает номер версии | Число ||
    || name | Название доски | Строка ||
    || createdAt | Дата создания доски в формате `YYYY-MM-DDThh:mm:ss.sss±hhmm` | Строка ||
    || updatedAt | Дата последнего обновления доски в формате `YYYY-MM-DDThh:mm:ss.sss±hhmm` | Строка ||
    || [createdBy](#createdby) | Блок с информацией о пользователе, создавшем доску | Объект ||
    || [columns](#ans-columns) | Блок с информацией о колонках доски | Массив объектов ||
    || useRanking | *Параметр устарел и не влияет на работу доски*

    Возможность менять порядок задач на доске:<ul><li>`true`— разрешено;</li><li>`false`— запрещено.</li></ul> | Логический ||
    || estimateBy | *Параметр устарел и не влияет на работу доски*

    Блок с информацией о поле задачи, которое используется для оценки трудоемкости | Объект ||
    || country | *Параметр устарел и не влияет на работу доски*

    Блок с информацией о стране. | Объект ||
    || calendar | Объект, который содержит идентификатор календаря. Данные календаря используются в диаграмме сгорания задач. | Объект ||
    || [autoFilterSettings](#autofilterset) | Блок с информацией о настройках фильтров, с помощью которых задачи автоматически добавляются на доску и удаляются с доски | Объект ||
    |#

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

    <!-- source: ru/api-ref/_includes/user.md -->
    Параметр | Описание | Тип данных
    ----- | ----- | -----
    self | Адрес ресурса API, который содержит информацию о пользователе. | Строка
    id | Идентификатор пользователя. | Строка
    display | Отображаемое имя пользователя. | Строка
    passportUid | Уникальный идентификатор аккаунта пользователя в организации Яндекс 360 для бизнеса и Яндекс ID. | Число
    cloudUid | Уникальный идентификатор пользователя в Yandex Identity Hub. | Строка
    <!-- endsource: ru/api-ref/_includes/user.md -->

    **Поля объекта** `columns` {#ans-columns}

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

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

    <!-- source: ru/api-ref/_includes/board-fields.md -->
    Параметр | Описание | Тип данных
    -------- | -------- | ----------
    addFilterSettings | Объект с настройками фильтра для автоматического добавления задач на доску | Объект
    removeFilterSettings | Объект с настройками фильтра для автоматического удаления задач с доски | Объект
    <!-- endsource: ru/api-ref/_includes/board-fields.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 %}

[*board]: Доска — это визуальное представление задач по колонкам. Каждая колонка соответствует статусу, например ![](../../_assets/svg/initial.svg), ![](../../_assets/svg/progress.svg), ![](../../_assets/svg/end.svg).