Skip to content
Day Planner

Checklist items

Checklist items are the tick-boxes inside a task. They attach to tasks, not documents: POST /api/checklist-items names the task with taskId, and items come back as checklistItems on the task in Tasks. There is no list endpoint. Every endpoint acts only on items whose task is yours and needs an API key or a signed-in session — see API keys. Requests without one get 401 Unauthorized; error responses carry an error message.

Create a checklist item

Section titled “Create a checklist item”

Adds a checklist item to a task.

POST /api/checklist-items

The body names the task and the item.

Body fields

Section titled “Body fields”
Name Type Required Description
taskId string Yes The task to attach it to; must be one of yours
title string Yes 1–500 characters

Response

Section titled “Response”

201 Created with the new item.

{
  "id": "8f1c5a3e-2b7d-4e9a-8c04-6d3b9f1e5a72",
  "taskId": "c9f2a5d8-3e6b-4a1c-9d7f-2b5e8a0c3f64",
  "title": "Book venue",
  "completed": false,
  "sortOrder": 0
}

New items start with completed set to false and sortOrder set to 0.

Errors

Section titled “Errors”
  • 400 Bad Request — a field failed validation; details names the fields.
  • 404 Not Found — no task of that id belongs to you; the error message is Task not found.
  • 401 Unauthorized — no valid API key or session.

Update a checklist item

Section titled “Update a checklist item”

Changes a checklist item.

PATCH /api/checklist-items/{id}

Every body field is optional; fields you leave out keep their values.

Body fields

Section titled “Body fields”
Name Type Required Description
title string No 1–500 characters
completed boolean No Tick the item on or off
sortOrder number No Position in the task’s checklist

Response

Section titled “Response”

200 OK with the updated item.

{
  "id": "8f1c5a3e-2b7d-4e9a-8c04-6d3b9f1e5a72",
  "taskId": "c9f2a5d8-3e6b-4a1c-9d7f-2b5e8a0c3f64",
  "title": "Book venue",
  "completed": true,
  "sortOrder": 0
}

Sending just completed ticks the item without touching its title.

Errors

Section titled “Errors”
  • 400 Bad Request — a field failed validation; details names the fields.
  • 404 Not Found — no item of that id belongs to one of your tasks; the error message is Not found.
  • 401 Unauthorized — no valid API key or session.

Delete a checklist item

Section titled “Delete a checklist item”

Deletes a checklist item for good.

DELETE /api/checklist-items/{id}

It takes no body.

Response

Section titled “Response”

200 OK once the item is gone.

{ "success": true }

Deleting an item never touches its task.

Errors

Section titled “Errors”
  • 404 Not Found — no item of that id belongs to one of your tasks; the error message is Not found.
  • 401 Unauthorized — no valid API key or session.

Example: tick off a checklist item

Section titled “Example: tick off a checklist item”

Mark a checklist item as done.

Terminal window
curl -X PATCH https://tasks.example.com/api/checklist-items/8f1c5a3e-2b7d-4e9a-8c04-6d3b9f1e5a72 \
  -H "Authorization: Bearer dp_change-me" \
  -H "Content-Type: application/json" \
  -d '{"completed":true}'

The response is 200 OK with the updated item.

See also

Section titled “See also”