Create checklistItem

Namespace: microsoft.graph

Create a new checklistItem object.


One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Permission type Permissions (from least to most privileged)
Delegated (work or school account) Tasks.ReadWrite
Delegated (personal Microsoft account) Tasks.ReadWrite
Application Tasks.ReadWrite.All

HTTP request

POST /me/todo/lists/{todoTaskListId}/tasks/{todoTaskId}/checklistItems
POST /users/{id | userPrincipalName}/todo/lists/{todoTaskListId}/tasks/{todoTaskId}/checklistItems

Request headers

Name Description
Authorization Bearer {token}. Required.
Content-Type application/json. Required.

Request body

In the request body, supply a JSON representation of the checklistItem object.

You can specify the following properties when creating a checklistItem.

Property Type Description
checkedDateTime DateTimeOffset The date and time when the checklistItem was finished.
createdDateTime DateTimeOffset The date and time when the checklistItem was created.
displayName String Field indicating the title of checklistItem.
isChecked Boolean State indicating whether the item is checked off or not.


If successful, this method returns a 201 Created response code and a checklistItem object in the response body.



Content-Type: application/json

    "displayName": "Final sign-off from the team"


Note: The response object shown here might be shortened for readability.

HTTP/1.1 201 Created
Content-Type: application/json

    "@odata.context": "$metadata#users('6f9a2a92-8527-4d64-937e-b5312852f35d')/todo/lists('AAMkADliMmU5YjJlLTVmMmQtNGQzNS1iYjA0LTdmZTA2NTI0MTE5YwAuAAAAAADdOMUbUmCfTKa7OC-fqjkdAQBnu3olF7NfToRyJ2f__TNcAAAAAAESAAA%3D')/tasks('AAkALgAAAAAAHYQDEapmEc2byACqAC-EWg0AZ7t6JRezX06Ecidn-vkzXAABPDii4gAA')/checklistItems/$entity",
    "displayName": "Final sign-off from the team",
    "createdDateTime": "2021-11-17T05:35:03.9736453Z",
    "isChecked": false,
    "id": "e3a26c2e-7c6f-4317-9d71-c27267008202"