Contact UsGet started

Deleting a checklist item

Written by
Updated at February 19, 2024

Use this request to delete a checklist item from an issue.

Request format

To delete a checklist item from an issue, use an HTTP DELETE request:

DELETE /v2/issues/<issue_ID_or_key>/checklistItems/<checklist_item_ID>
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID: <organization ID>
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.
Resource
Parameter Description Data type
<issue_ID_or_key> Issue ID or key. String
<checklist_item_ID> Сhecklist item ID. To get the ID, run a request. String

Response format

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 items and the issue the checklist item was deleted from.

{
    "self": "https://https://api.tracker.yandex.net/v2/issues/ORG-3",
    "id": "5f981c00b982f075********",
    "key": "ORG-3",
    "version": 151,
    "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/19********",
        "id": "19********",
        "display": "Full Name"
    },
    "checklistDone": "0",
    "project": {
      "self": "https://https://api.tracker.yandex.net/v2/projects/7",
      "id": "7",
      "display": "Project name"
    },
    "description": "Issue description",
    "boards": [
            {
              "id": 14
            }
        ],
    "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/19********",
            "id": "19********",
            "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,
               "assignee": {
                  "id": 11********,
                  "display": "Full Name",
                  "passportUid": 11********,
                  "login": "user_login",
                  "firstName": "First name",
                  "lastName": "Last name",
                  "email": "user_login@example.com",
                  "trackerUid": 11********
                  },
               "deadline": {
                  "date": "2021-05-09T00:00:00.000+0000",
                  "deadlineType": "date",
                  "isExceeded": false
                  },
               "checklistItemType": "standard"  
         },
       ...
      ],
   "checklistTotal": 4,
   "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": "2021-02-16T08:28:41.095+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. Number
key Issue key. String
version Issue version. Each change of the parameters increases the version number. Number
lastCommentUpdatedAt Last comment's update time. String
pendingReplyFrom Object with information about the employee whose response is awaited. Object
summary Issue name. String
statusStartTime Issue creation time. String
updatedBy Object with information about the employee who edited the issue last. Object
checklistDone Number of checklist items that are marked as done. Number
project Object with information about the project the issue belongs to. Object
description Issue description. String
boards Array of objects with information about the issue boards. Object
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
checklistTotal Number of checklist items. Number
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
queue Object with information about the issue queue. Object
updatedAt Date and time when the issue was last updated. String
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

project object fields

Parameter Description Data type
self Address of the API resource with information about the project. String
id Project ID. String
display Project display name. String

boards object fields

Parameter Description Data type
id Board ID Number

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
assignee Assignee of the checklist item. Object
deadline Deadline for the checklist item. Object
checklistItemType Type of the checklist item. String

assignee object fields

Parameter Description Data type
id User ID. Number
display Displayed user name. String
passportUid Unique ID of the user's Yandex account. Number
login User's login. String
firstName Username. String
lastName User's last name. String
email User's email address. String
trackerUid Unique ID of the user Tracker account. Number

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
isExceeded Flag indicating if the deadline has passed:
  • true: Passed.
  • false: Not passed.
 Logical

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.
401
The user isn't authorized. Make sure to perform the actions described in API access.
403
Insufficient rights to perform this action. You can check what rights you have in the Tracker interface. The same rights are required to perform an action via the API and interface.
404
The requested object was not found. You may have specified an invalid object ID or key.
Previous
Deleting a checklist
Next
Creating a project