Creating a checklist or adding items to it

Use this request to create a checklist in a project or portfolio and add new items to it. New items are added to the end of the list. For more information about checklists, see Creating a checklist.

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 create a new checklist or add items to an existing one, use an HTTP POST request. Information about new items is transmitted in its body in JSON format.

POST /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>

{
  "text": "Item text",
  "checked": true,
  "assignee": "username",
  "deadline": {
    "date": "2021-05-09T00:00:00.000+0000",
    "deadlineType": "date"
  }
}

Example: Adding two items to a checklist

• An HTTP POST method is used.
• The checklist is updated with a new item: "First list item".
• The checklist is updated with a new item: "Second list item" (marked as completed).
• The response displays information about all the checklist items (fields=checklistItems).

POST /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>

[
  {
     "text": "First list item"
  },
  {
     "text": "Second list item",
     "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/11********",
        "id": "11********",
        "display": "User Name",
        "cloudUid": "ajeppa7dgp53********",
        "passportUid": 11********
    },
    "createdAt": "2023-12-13T15:06:27.231Z",
    "updatedAt": "2023-12-13T15:06:27.231Z",
    "fields": {
        "checklistItems": [
           {
               "id": "6586d91f99a40477********",
               "text": "First list item",
               "checked": false,
               "checklistItemType": "standard"
           },
           {
               "id": "6586d91f99a40477********",
               "text": "Second list item",
               "checked": true,
               "checklistItemType": "standard"
           }
        ]
    }
}