Deleting a checklist item

Use this request to delete an item from a checklist (in projects and portfolios) or an item from a list of key results (in goals). The action cannot be undone.

DELETE

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

Query format

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

To delete a checklist item, use an HTTP DELETE request. In the request body, specify the parameters in JSON format.

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

Headers

Host: Address of the node that provides the API.
Authorization: Authorization token about these formats:
- OAuth <OAuth_token>: For authorization using the OAuth 2.0 protocol. Learn more
- Bearer <IAM_token>: For authorization using an IAM token, if a Yandex Cloud Organization organization is linked to Tracker. Learn more
X-Org-ID or X-Cloud-Org-ID: Organization ID.
- Use the X-Org-ID header if a Tracker organization is linked to Yandex 360 for Business.
- Use the X-Cloud-Org-ID header if a Tracker organization is linked to Yandex Cloud Organization.
To get the organization ID, go to Administration → Organizations and copy the value from the ID field.

Resource

Parameter	Description	Data type
<entity_type>	Entity type: project portfolio goal	String
<entity_ID>	Entity ID. To get the ID, see the entity list. You can use the `id` or `shortId` parameter as the ID.	String
<checklist_item_ID>	hecklist item ID. To get the ID, see the entity parameters.	String

Request parameters

Additional parameters

Parameter	Description	Data type
notify	Notify the users specified in the Author, Responsible, Participants, Customers, and Followers fields. The default value is `true`.	Boolean
notifyAuthor	Notify the author of the changes. The default value is `false`.	Boolean
fields	Additional entity fields to include in the response	String
expand	Additional information to include in the response: `attachments`: Attached files	String

Example: Deleting a checklist item

An HTTP DELETE method is used.

The item with the 6586d6fee2b9ef72******** ID is deleted from the checklist (hecklist item 2).

The response displays information about all the checklist items (fields=checklistItems).
DELETE https://api.tracker.yandex.net/v3/entities/project/<project_ID>/checklistItems/<checklist_item_ID>?fields=checklistItems

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 information about the entity and the checklist in JSON 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": "6586d6fee2b9ef71********",
               "text": "Checklist item 1.",
               "checked": false,
               "checklistItemType": "standard"
           },
           {
               "id": "6586d6fee2b9ef73********",
               "text": "Checklist item 3.",
               "checked": true,
               "checklistItemType": "standard"
           }
        ]
    }
}

Response parameters

Parameter	Description	Data type
self	Address of the API resource with information about the entity	String
id	Entity ID	String
version	Entity version. Each change of the parameters increases the version number. Entity edits will be disabled if the version number reaches the threshold value of `10100` (for robots) or `11100` (for users)	Number
shortId	Goal, project, or portfolio ID in Yandex Tracker	String
entityType	Entity type	String
createdBy	Block with information about the entity creator	Map object
createdAt	Entity creation date in `YYYY-MM-DDThh:mm:ss.sss±hhmm` format	String
updatedAt	Date when the entity was last updated, in `YYYY-MM-DDThh:mm:ss.sss±hhmm` format	String
fields	Block with additional entity fields	Map object

createdBy object fields

Parameter	Description	Data type
self	Address of the API resource with information about the user	String
id	User ID.	String
display	Displayed user name	String
passportUid	Unique ID of the user account in the Yandex 360 for Business organization and Yandex ID.	Number
cloudUid	Unique user ID in Yandex Cloud Organization	String

fields object fields

Parameter	Description	Data type
checklistItems	Information about checklist items.	Array of objects

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

423: Object edits disabled. The version parameter value limit (the maximum number of object updates) might have been exceeded. The maximum version value is 10100 for robots and 11100 for users.

Was the article helpful?

Deleting a checklist

Getting a list of attached files