Editing a checklist

Use this request to edit checklist items (in projects and portfolios) or items in the list of key results (in goals).

https://api.tracker.yandex.net/v3/entities/<entity_type>/<entity_ID>/checklistItems

Query format

Before making a request, get permission to access the API.

To edit checklist items, use an HTTP PATCH request. In the request body, specify the parameters in JSON format.

PATCH /v3/entities/<entity_type>/<entity_ID>/checklistItems
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID or X-Cloud-Org-ID: <organization_ID>

{
  "id": "<item_ID>",
  "text": "<item_text>",
  "checked": true,
  "assignee": "<assignee_ID_or_login>",
  "deadline": {
    "date": "2021-05-09T00:00:00.000+0000",
    "deadlineType": "date"
  },
}

Example: Editing two checklist items

• An HTTP PATCH method is used.
• The first checklist item name changes to Edited checklist item 1. Other field values are reset (assignee, deadline, completion flag, and item type).
• The second item gets a different assignee and a completion flag. Other field values are reset (deadline and item type).
• The response displays information about all the checklist items (fields=checklistItems).

PATCH /v3/entities/project/<project_ID>/checklistItems?fields=checklistItems
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID or X-Cloud-Org-ID: <organization_ID>

[
  {
     "id": "658953a65c0f1b21********",
     "text":"Edited checklist item 1."
  },
  {
     "id": "658953a65c0f1b21********",
     "text":"Checklist item 2.",
     "assignee": 19*********,
     "checked": true
  }
]

Response format

{
    "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/19********",
        "id": "19********",
        "display": "Full name",
        "cloudUid": "ajeppa7dgp53********",
        "passportUid": "15********"
    },
    "createdAt": "2023-12-13T15:06:27.231Z",
    "updatedAt": "2023-12-13T15:06:27.231Z",
    "fields": {
        "checklistItems": [
           {
               "id": "6586d91f99a40477********",
               "text": "Edited checklist item 1.",
               "checked": false,
               "assignee": {"assignee"},
               "checklistItemType": "standard"
           },
           {
               "id": "6586d91f99a40477********",
               "text": "Checklist item 2.",
               "checked": true,
               "checklistItemType": "standard"
           }
        ]
    }
}