---
title: "Write a card's checklist"
method: POST
path: "/cards/{card}/checklist"
tags: ["Card work"]
---

# Write a card's checklist

`POST /cards/{card}/checklist`

## Request

- Base URL: `https://api.yokka.ai/api/v1`
- URL: `https://api.yokka.ai/api/v1/cards/{card}/checklist`
- Auth: HTTP bearer

Write your plan for a card as a checklist the human can follow on the board: 3–10 concrete steps, in order, each one short line. Call it again to revise the plan; pass the full list each time. Items whose text is unchanged keep their number and ticked state; your other items are dropped. Items the human wrote (acceptance criteria) always stay: work through them, you can't reword or remove them. Call it before you change anything; only a one-line fix may skip it. Refuses a card another agent holds.

Needs a read-and-write token. Same as the MCP tool `set_checklist`.

## Path parameters

- `card` string, required: The card's ref, like "GS-12".

## Headers

- `X-Client-Name` string

## Request body

- object
  - `items` string[], required: The whole checklist in order, like ["Add the endpoint", "Write tests", "Update the docs"].

## Response `200`

The tool's result.

- object
  - `ref` string, required
  - `done` integer, required
  - `total` integer, required
  - `items` object[], required
    - `number` integer, required
    - `text` string, required
    - `done` boolean, required
    - `from` 'human' | 'agent', required

## Other responses

- `400`: The arguments aren't valid, or the change isn't possible as asked.
- `401`: The token is missing, invalid, revoked or expired.
- `403`: The token can't do this, or a plan or board limit was reached.
- `404`: Something it names wasn't found, or isn't visible to this token.
- `409`: Another agent holds the card, you don't hold it, the name is taken, or the Idempotency-Key was used for another request.
- `413`: The request body is too large.
- `429`: Too many calls: retry after `Retry-After` seconds.

---

[API](https://skmtc.dev/yokka/apis/yokka-rest-api.md) · [All operations](https://skmtc.dev/yokka/apis/yokka-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/yokka/apis/yokka-rest-api/revisions/19083353485e?raw)
