Creating a checklist or adding items to it

Written by

Updated at February 19, 2024

Request format
Response format

Use this request to create a checklist and add new items to it.

Request format

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

To create a new checklist or add items to an existing one, use an HTTP POST request. Request parameters are provided in the request body in JSON format.

POST /v2/issues/<issue_ID_or_key>/checklistItems
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID: <organization ID>

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

Headers

Host

Address of the node that provides the API:
```
https://api.tracker.yandex.net
```
Authorization

OAuth token in OAuth <OAuth_token> format, e.g.:
```
OAuth 0c4181a7c2cf4521964a72ff********
```
X-Org-ID or X-Cloud-Org-ID

Organization ID. You can find it out on the Tracker organizations page.
- If a Yandex 360 for Business organization is the only one linked to Tracker, the X-Org-ID header is used.
- If a Yandex Cloud Organization organization is the only one linked to Tracker, the X-Cloud-Org-ID header is used.
- If both Yandex 360 for Business and Yandex Cloud Organization organizations are linked to Tracker at the same time, the X-Org-ID header and the Yandex 360 for Business organization ID are used.

Request body parameters

The request body contains the information required to create a checklist or add an item to a checklist:

Required parameters

Parameter	Description	Data type
text	Text of the item.	String

Additional parameters

Parameter	Description	Data type
checked	Item completion flag: `true`: Item marked as completed. `false`: Item not marked as completed.	Logical
assignee	ID or username of the user that the checklist item is assigned to.	String
deadline	Deadline for the checklist item.	Object

deadline object fields

Parameter	Description	Data type
date	Deadline in `YYYY-MM-DDThh:mm:ss.sss±hhmm` format.	Date
deadlineType	The `deadline` parameter data type.	String

Response format

Request executed successfully

Request failed

If the request is successful, the API returns a response with code 200 OK.

The response body contains a JSON object with the parameters of the checklist and the issue it was added to.

{
    "self": "https://https://api.tracker.yandex.net/v2/issues/ORG-3",
    "id": "5f981c00b982f075********",
    "key": "ORG-3",
    "version": 133,
    "lastCommentUpdatedAt": "2020-12-13T13:18:22.965+0000",
    "pendingReplyFrom": [
        {
            "self": "https://https://api.tracker.yandex.net/v2/users/12********",
            "id": "12********",
            "display": "Full Name"
        }
    ],
    "summary": "Issue name",
    "statusStartTime": "2020-11-03T11:19:24.733+0000",
    "updatedBy": {
        "self": "https://https://api.tracker.yandex.net/v2/users/12********",
        "id": "12********",
        "display": "Full Name"
    },
    "description": "Issue description",
    "type": {
        "self": "https://https://api.tracker.yandex.net/v2/issuetypes/2",
        "id": "2",
        "key": "task",
        "display": "Issue"
    },
    "priority": {
        "self": "https://https://api.tracker.yandex.net/v2/priorities/3",
        "id": "3",
        "key": "normal",
        "display": "Normal"
    },
    "previousStatusLastAssignee": {
        "self": "https://https://api.tracker.yandex.net/v2/users/12********",
        "id": "12********",
        "display": "Full Name"
    },
    "createdAt": "2020-10-27T13:09:20.085+0000",
    "followers": [
        {
            "self": "https://https://api.tracker.yandex.net/v2/users/12********",
            "id": "12********",
            "display": "Full Name"
        }
    ],
    "createdBy": {
        "self": "https://https://api.tracker.yandex.net/v2/users/12********",
        "id": "12********",
        "display": "Full Name"
    },
    "checklistItems": [
        {
            "id": "5fde5f0a1aee261d********",
            "text": "checklist item",
            "textHtml": "item text in HTML format",
            "checked": false,
            "checklistItemType": "standard"
        }
    ],
    "votes": 0,
    "assignee": {
        "self": "https://https://api.tracker.yandex.net/v2/users/12********",
        "id": "12********",
        "display": "Full Name"
    },
    "deadline": "2020-10-28",
    "queue": {
        "self": "https://https://api.tracker.yandex.net/v2/queues/ORG",
        "id": "1",
        "key": "ORG",
        "display": "Startrek"
    },
    "updatedAt": "2020-12-19T20:14:02.648+0000",
    "status": {
        "self": "https://https://api.tracker.yandex.net/v2/statuses/2",
        "id": "2",
        "key": "needInfo",
        "display": "Need info"
    },
    "previousStatus": {
        "self": "https://https://api.tracker.yandex.net/v2/statuses/3",
        "id": "3",
        "key": "inProgress",
        "display": "In progress"
    },
    "favorite": false
}

Response parameters

Parameter	Description	Data type
self	Address of the API resource with information about the issue.	String
id	Issue ID.	String
version	Issue version. Each change of the parameters increases the version number.	Number
key	Issue key.	String
pendingReplyFrom	Object with information about the employee whose response is awaited.	Object
lastCommentUpdatedAt	Last comment's update time.	String
summary	Issue name.	String
statusStartTime	Issue creation time.	String
updatedBy	Object with information about the employee who edited the issue last.	Object
description	Issue description.	String
type	Object with information about the issue type.	Object
priority	Object with information about the priority.	Object
previousStatusLastAssignee	Object with information about the assignee of the issue in the previous status.	Object
createdAt	Issue creation date and time.	String
followers	Array of objects with information about issue followers.	Object
createdBy	Object with information about the user who created the issue.	Object
checklistItems	Array of objects with information about checklist items.	Object
votes	Number of votes for the issue.	Number
assignee	Object with information about the issue's assignee.	Object
deadline	Deadline for completing the issue.	String
updatedAt	Date and time when the issue was last updated.	String
queue	Object with information about the issue queue.	Object
status	Object with information about the issue status.	Object
previousStatus	Object with information about the previous status of the issue.	Object
favorite	Favorite issue flag: `true`: Issue added to favorites by the user. `false`: Issue not added to favorites.	Number

updatedBy object fields

Parameter	Description	Data type
self	Address of the API resource with information about the user.	String
id	User ID.	Number
display	Displayed user name.	String

pendingReplyFrom object fields

Parameter	Description	Data type
self	Address of the API resource with information about the user.	String
id	User ID.	Number
display	Displayed user name.	String

type object fields

Parameter	Description	Data type
self	Link to the issue type.	String
id	Issue type ID	String
key	Issue type key.	String
display	Issue type name displayed.	String

priority object fields

Parameter	Description	Data type
self	Link to the priority type.	String
id	Priority ID	String
key	Priority key.	String
display	Priority name displayed.	String

previousStatusLastAssignee object fields

Parameter	Description	Data type
self	Address of the API resource with information about the user.	String
id	User ID.	Number
display	Displayed user name.	String

followers object fields

Parameter	Description	Data type
self	Address of the API resource with information about the user.	String
id	User ID.	Number
display	Displayed user name.	String

createdBy object fields

Parameter	Description	Data type
self	Address of the API resource with information about the user.	String
id	User ID.	Number
display	Displayed user name.	String

checklistItems object fields

Parameter	Description	Data type
id	Сhecklist item ID.	String
text	Text of the checklist item.	String
textHtml	Text of the checklist item in HTML format.	String
checked	Checklist item completion flag: `true`: Item marked as completed. `false`: Item not marked as completed.	Logical
checklistItemType	Type of the checklist item.	String

assignee object fields

Parameter	Description	Data type
self	Address of the API resource with information about the user.	String
id	User ID.	Number
display	Displayed user name.	String

queue object fields

Parameter	Description	Data type
self	Queue link.	String
id	Queue ID.	Number
key	Queue key.	String
display	Queue name displayed.	String

status object fields

Parameter	Description	Data type
self	Status link.	String
id	Status ID.	String
key	Status key.	String
display	Status name displayed.	String

previousStatus object fields

Parameter	Description	Data type
self	Status link.	String
id	Status ID.	String
key	Status key.	String
display	Status name displayed.	String

If the request is processed incorrectly, the API returns a response with an error code:

400: One or more request parameters have an invalid value.

404: The requested object was not found. You may have specified an invalid object ID or key.

422: JSON validation error, the request is rejected.

Creating a checklist or adding items to it

Request formatRequest format

Response formatResponse format

Was the article helpful?

Request format

Response format