---
metadata:
  - name: generator
    content: Diplodoc Platform v5.57.3
  - 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/entities/checklists/patch-checklist.md
  - https://yandex.ru/support/tracker/ru/api/entities/checklists/patch-checklist.md
  - href: ru/api/entities/checklists/patch-checklist.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


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

Запрос позволяет редактировать пункты чеклиста в проектах и портфелях. [Как использовать чеклисты](https://yandex.ru/support/tracker/user/checklist.html).

<div class="request_example method_patch yfm-clipboard">
    <p>PATCH</p>
    <pre><code>https://api.tracker.yandex.net/v3/entities/&lt;тип_сущности>/&lt;id_сущности>/checklistItems</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/_assets/style/methods.md -->

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

{% note tip "" %}

Чтобы изменить чеклист, вы также можете использовать запрос [Изменить сущность](https://yandex.ru/support/tracker/ru/api/entities/update-entity.md). В теле запроса передайте объект `fields` с вложенным массивом  `checklistItems`: см. [Дополнительные параметры сущности](https://yandex.ru/support/tracker/ru/api/entities/about-entities.md#query-params).

{% endnote %}

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

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

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

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

[
  {
    "id": "658953a65c0f1b21********",
    "text": "Item text",
    "checked": true,
    "assignee": "username",
    "deadline": {
      "date": "2021-05-09T00:00:00.000+0000",
      "deadlineType": "date"
    }
  },
  {
    ...
  }
]
```

<!-- source: ru/api/_includes/headings.md -->
{% cut "Заголовки" %}

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

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

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

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

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


* <!-- source: ru/api/_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/_includes/org-id.md -->

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


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

<!-- source: ru/api/_includes/resource-entity.md -->
{% cut "Ресурс" %}

Параметр | Описание | Тип данных
-------- | -------- | ----------
\<тип_сущности> | Тип сущности:<ul><li>project — проект;</li><li>portfolio — портфель | Строка
\<id_сущности> | Идентификатор сущности. Чтобы получить идентификатор, посмотрите [список сущностей](../search-entities.md). В качестве идентификатора можно использовать параметр `id` или `shortId`.| Строка

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

<!-- source: ru/api/_includes/query-params-checklist.md -->
{% cut "Параметры запроса" %}

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

Параметр | Описание | Тип данных
-------- | -------- | ----------
notify | Уведомлять пользователей, которые указаны в полях **Автор**, **Ответственный**, **Участники**, **Заказчики** и **Наблюдатели**. Значение по умолчанию — `true`. | Логический
notifyAuthor | Уведомлять автора изменений. Значение по умолчанию — `false`. | Логический
[fields](../about-entities.md#query-params) | Дополнительные поля сущности, которые будут включены в ответ. | Строка
expand | Дополнительная информация, которая будет включена в ответ: <ul><li>`attachments` — вложенные файлы.</li></ul> | Строка

{% endcut %}
<!-- endsource: ru/api/_includes/query-params-checklist.md -->

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

Тело запроса содержит информацию, необходимую для внесения изменений в пункты чеклиста:

**Обязательные параметры**

Параметр | Описание | Тип данных
----- | ----- | -----
id | Идентификатор пункта. | Строка
text | Текст пункта чеклиста. | Строка

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

{% note warning "" %}

* Если значение дополнительного параметра не указано, оно будет сброшено к значению по умолчанию, в зависимости от типа поля (пустая строка, `0`, `null`, `false`). Повторите значения параметров, которые не меняли.
* Количество пунктов не может меняться. Можно отдельно [добавить](https://yandex.ru/support/tracker/ru/api/entities/checklists/add-checklist.md) или [удалить](https://yandex.ru/support/tracker/ru/api/entities/checklists/delete-checklist-item.md) пункты в чеклисте.

{% endnote %}

Параметр | Описание | Тип данных
----- | ----- | -----
checked | Отметка о выполнении пункта: <ul><li>`true` — пункт отмечен как выполненный;</li><li>`false` — пункт не отмечен как выполненный.</li></ul> | Логический
assignee | Идентификатор или логин пользователя, который назначен исполнителем пункта чеклиста. | Число или строка
deadline | Дедлайн пункта чеклиста. | Объект

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

Параметр | Описание | Тип данных
----- | ----- | -----
date | Дата дедлайна в формате `YYYY-MM-DDThh:mm:ss.sss±hhmm`. | Дата
deadlineType | Тип данных параметра `deadline`. | Строка

{% endcut %}

> Пример: Изменить два пункта в чеклисте
>
> - Используется HTTP-метод PATCH.
> - В первом пункте чеклиста меняется название на «Измененный первый пункт чеклиста». Значения остальных полей сбрасываются (исполнитель, дедлайн, отметка о выполнении и тип пункта).
> - Во втором пункте изменяется исполнитель и ставится отметка о выполнении. Значения остальных полей сбрасываются (дедлайн и тип пункта).
> - В ответе выводится информация о всех пунктах чеклиста (`fields=checklistItems`).
>
> ```json translate=no
> PATCH /v3/entities/project/<id_проекта>/checklistItems?fields=checklistItems
> Host: api.tracker.yandex.net
> Authorization: OAuth y0__xAbc******
> Content-Type: application/json
> X-Org-ID: 1234******
>
> [
>   {
>      "id": "658953a65c0f1b21********",
>      "text": "First list item"
>   },
>   {
>      "id": "658953a65c0f1b21********",
>      "text":"Second list item",
>      "assignee": 19*********,
>      "checked": true
>   }
> ]
> ```

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

{% list tabs %}

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

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

  Тело ответа содержит информацию о сущности, о вложениях сущности и о пунктах чеклиста в формате JSON.

  ```json translate=no
  {
      "self": "https://api.tracker.yandex.net/v3/entities/project/6586d6fee2b9ef74********",
      "id": "6586d6fee2b9ef74********",
      "version": 133,
      "shortId": 0,
      "entityType": "project",
      "createdBy": {
          "self": "https://api.tracker.yandex.net/v3/users/11********",
          "id": "11********",
          "display": "Имя Фамилия",
          "cloudUid": "ajeppa7dgp53********",
          "passportUid": 11********
      },
      "createdAt": "2023-12-13T15:06:27.231Z",
      "updatedAt": "2023-12-13T15:06:27.231Z",
      "fields": {
          "checklistItems": [
             {
                 "id": "6586d91f99a40477********",
                 "text": "Modified list item",
                 "checked": false,
                 "assignee": {
                    "id": 133******,
                    "passportUid": 133******,
                    "login": "username",
                    "display": "Имя Фамилия",
                    ...
                  },
                 "checklistItemType": "standard"
             },
             {
                 "id": "6586d91f99a40477********",
                 "text": "Second list item",
                 "checked": true,
                 "checklistItemType": "standard"
             }
          ]
      }
  }
  ```

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

  <!-- source: ru/api/_includes/entity.md -->
  Параметр | Описание | Тип данных
  -------- | -------- | ----------
  self | Адрес ресурса API, который содержит информацию о сущности | Строка
  id | Идентификатор сущности | Строка
  version | Версия сущности. Каждое изменение параметров увеличивает номер версии. <br>Редактирование сущности будет заблокировано, если версия достигнет предельного значения: для роботов `10100`, для пользователей `11100` | Число
  shortId | Числовой идентификатор сущности | Число
  entityType | Тип сущности | Строка
  createdBy | Блок с информацией о создателе сущности | Объект
  createdAt | Дата создания сущности в формате `YYYY-MM-DDThh:mm:ss.sss±hhmm` | Строка
  updatedAt | Дата последнего обновления сущности в формате `YYYY-MM-DDThh:mm:ss.sss±hhmm` | Строка
  [fields](../about-entities.md#query-params) | Блок с дополнительными полями сущности | Объект
  <!-- endsource: ru/api/_includes/entity.md -->

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

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

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

  Параметр | Описание | Тип данных
  ----- | ----- | -----
  checklistItems | Информация о пунктах чеклиста. | Массив объектов

  **Поля объекта** `checklistItems` {#checklist-items}

  <!-- source: ru/api/_includes/checklist-items.md -->
  Параметр | Описание | Тип данных
  ----- | ----- | -----
  id | Идентификатор пункта чеклиста. | Строка
  text | Текст пункта чеклиста. | Строка
  textHtml | Текст пункта чеклиста в формате HTML. | Строка
  checked | Признак выполнения пункта чеклиста:<ul><li>`true` — пункт отмечен как выполненный;</li><li>`false` — пункт не отмечен как выполненный.</li></ul> | Логический
  assignee | Исполнитель пункта чеклиста. | Объект
  [deadline](#deadline-checklist) | Крайний срок исполнения пункта чеклиста. | Объект
  checklistItemType | Тип пункта чеклиста. | Строка
  <!-- endsource: ru/api/_includes/checklist-items.md -->

  {% endcut %}

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

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

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

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

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

  <!-- source: ru/api/_includes/answer-error-423.md -->
  423
  :   Редактирование объекта заблокировано. Возможно, превышено допустимое значение параметра `version` — количество обновлений объекта. Максимальное значение версии составляет `10100` для роботов и `11100` для пользователей. 
  <!-- endsource: ru/api/_includes/answer-error-423.md -->

{% endlist %}