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

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

PATCH

https://api.tracker.yandex.net/v3/boards/<id_доски>

Формат запроса

Перед выполнением запроса получите доступ к API.

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

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

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

Заголовки

Host: адрес узла, предоставляющего API.
Authorization: токен для авторизации в одном из форматов:
- OAuth <OAuth-токен> при авторизации по протоколу OAuth 2.0. Читать подробнее
- Bearer <IAM-токен> при авторизации с помощью IAM-токена — если к Трекеру привязана организация Yandex Cloud Organization. Читать подробнее
X-Org-ID или X-Cloud-Org-ID: идентификатор организации.
- если к Трекеру привязана организация Яндекс 360 для бизнеса, используйте заголовок X-Org-ID,
- если к Трекеру привязана организация Yandex Cloud Organization, используйте заголовок X-Cloud-Org-ID.
Чтобы узнать идентификатор организации, перейдите на страницу Администрирование → Организации и скопируйте значение поля идентификатор.

Ресурс

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

Параметры тела запроса

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

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

Параметр	Описание	Тип данных
name	Название доски	Строка
backlogAvailable sprintsAvailable	Опции для включения бэклога и спринтов на доске задач: Если оба параметра одновременно имеют значение `true`, бэклог и спринты включены Если оба параметра одновременно имеют значение `false`, бэклог и спринты отключены Что такое бэклог и спринты	Логический
columns	Перечисление колонок доски	Массив объектов
backlogColumns	Перечисление дополнительных колонок в бэклоге. Что такое колонки в бэклоге	Массив объектов
nonParametrizedColumns	Перечисление произвольных колонок, не привязанных к статусам задач. Что такое произвольные колонки	Массив объектов

Поля объекта columns

Параметр	Описание	Тип данных
name	Название колонки	Строка
statuses	Список статусов, задачи которых отображаются в колонке Имена и ключи статусов можно посмотреть на странице Настройки Трекера	Массив строк или чисел
limit	Предельное количество задач в колонке	Число

Поля объекта backlogColumns

Параметр	Описание	Тип данных
name	Название колонки в бэклоге	Строка
limit	Предельное количество задач в колонке	Число

Поля объекта nonParametrizedColumns

Параметр	Описание	Тип данных
name	Название колонки	Строка
limit	Предельное количество задач в колонке	Число

Пример: Изменить параметры доски с идентификатором 5:

Настроить две колонки со статусами open и closed;

Отключить бэклог и спринты.
PATCH /v3/boards/5
Host: api.tracker.yandex.net
Authorization: OAuth y0__xAbc******
X-Org-ID: 1234******

{
 "name": "Testing new",
 "columns": [
   {
     "name": "Open",
     "statuses": "open"
   },
   {
     "name": "Closed",
     "statuses": "closed"
   }
 ],
 "backlogAvailable": false,
 "sprintsAvailable": false
}

Формат ответа

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

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

В случае успешного выполнения запроса API возвращает ответ с кодом 200 OK.

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

{
    "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
    }
}

Параметры ответа

Параметр	Описание	Тип данных
self	Адрес ресурса API, который содержит параметры доски	Строка
id	Идентификатор доски	Число
version	Версия доски. Каждое изменение доски увеличивает номер версии	Число
name	Название доски	Строка
createdAt	Дата создания доски в формате `YYYY-MM-DDThh:mm:ss.sss±hhmm`	Строка
updatedAt	Дата последнего обновления доски в формате `YYYY-MM-DDThh:mm:ss.sss±hhmm`	Строка
createdBy	Блок с информацией о пользователе, создавшем доску	Объект
columns	Блок с информацией о колонках доски	Массив объектов
useRanking	Параметр устарел и не влияет на работу доски Возможность менять порядок задач на доске: `true`— разрешено; `false`— запрещено.	Логический
estimateBy	Параметр устарел и не влияет на работу доски Блок с информацией о поле задачи, которое используется для оценки трудоемкости	Объект
country	Параметр устарел и не влияет на работу доски Блок с информацией о стране.	Объект
calendar	Объект, который содержит идентификатор календаря. Данные календаря используются в диаграмме сгорания задач.	Объект
autoFilterSettings	Блок с информацией о настройках фильтров, с помощью которых задачи автоматически добавляются на доску и удаляются с доски	Объект

Поля объекта createdBy

Параметр	Описание	Тип данных
self	Адрес ресурса API, который содержит информацию о пользователе.	Строка
id	Идентификатор пользователя.	Строка
display	Отображаемое имя пользователя.	Строка
passportUid	Уникальный идентификатор аккаунта пользователя в организации Яндекс 360 для бизнеса и Яндекс ID.	Число
cloudUid	Уникальный идентификатор пользователя в Yandex Cloud Organization.	Строка

Поля объекта columns

Параметр	Описание	Тип данных
self	Адрес ресурса API, который содержит информацию о параметре задачи	Строка
id	Идентификатор параметра задачи	Строка
display	Отображаемое название параметра	Строка

Поля объекта autoFilterSettings

Параметр	Описание	Тип данных
addFilterSettings	Объект с настройками фильтра для автоматического добавления задач на доску	Объект
removeFilterSettings	Объект с настройками фильтра для автоматического удаления задач с доски	Объект

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

400: Один или несколько параметров запроса имеют недопустимое значение.

403: У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Трекера — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.

404: Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.

412: При редактировании объекта возник конфликт. Возможно, ошибка возникла из-за неправильно указанной версии изменений.

422: Ошибка валидации JSON, запрос отклонен.

428: Доступ к ресурсу отклонен. Проверьте, указаны ли все обязательные условия выполнения запроса.

500: Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.

503: Сервис API временно недоступен.

Была ли статья полезна?

Создать доску

Удалить доску