Replace a work item's checklist
/v1/work-items/{item}/checklists/{kind} in the Work Items API.
curl -X PUT https://api.example.test/v1/work-items/$ITEM_ID/checklists/definition_of_done \ -H "Authorization: Bearer $TOKEN" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d '{"items": [{"id": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d", "text": "The code is reviewed and merged", "required": true, "done": true}, {"text": "The feature flag is on in production"}]}'Replaces the entries of one list, definition_of_ready or definition_of_done: a row with an id keeps that entry and changes it, a row without one adds an entry, entries left out are removed, and a done that differs from the entry's state ticks or unticks it with the token holder's stamp. Answers 200 with the list and emits work_item.checklist_changed with the tally; a replace that changes nothing emits nothing. The item's own record and its versions are untouched.
Requires ability
The token must hold this ability, or the call is refused with 403.
Fires one event
Delivered to every endpoint subscribed to it once the change is made.
Idempotent
Send the header on every call; the same key replays the original response for 24 hours.
Authorization
bearerToken A personal access token minted in the app under Account Settings, then API Tokens, sent as Authorization: Bearer zg_live_…. The token carries the abilities each endpoint lists under Requires ability and is frozen to one team, and optionally to one project, at mint time.
In: header
Path Parameters
The item, bound by the middleware.
uuidWhich list: definition_of_ready or definition_of_done.
Value in
- "definition_of_ready"
- "definition_of_done"
- "go_live"
- "post_mortem_actions"
- "custom"
Header Parameters
A key unique to this operation, such as a fresh UUID. The same key replays the original 2xx response for 24 hours (with Idempotent-Replay: true), so a retry after a timeout never repeats the write; the same key with a different body is refused with 409.
uuidRequest body
JSONWhat the request carriesRequiredapplication/json
The full list of entries the checklist should have, in order. A row with an id keeps that entry and its tick unless done says otherwise; a row without one is new; entries left out are removed.
Responses
200OKapplication/json
The list after the change.
400Bad requestIDEMPOTENCY_KEY_MISSINGapplication/json
Every write needs an Idempotency-Key header. Send a fresh UUID per distinct operation.
401UnauthorizedAUTHENTICATION_REQUIREDapplication/json
The request carries no bearer token, or one that is revoked, malformed, or minted for another environment (a zg_test_ token on production).
403ForbiddenTOKEN_MISSING_ABILITYapplication/json
The token is valid but does not carry the ability this endpoint requires; error.context.required_ability names the one to grant. An endpoint that also checks who registered a row answers FORBIDDEN with the same status, and says so in its own description.
On this endpoint: FORBIDDEN: when the token holder's role on the project does not carry work-item:update.
404Not foundRESOURCE_NOT_FOUNDapplication/json
An id in the path names nothing the token can see. TENANT_MISMATCH: the project sits outside the token's scope:project: allow-list, or the token carries no team scope. Both answer 404 rather than 403 so that existence outside the token's scope cannot be inferred.
On this endpoint: RESOURCE_NOT_FOUND: when {kind} is not one of the two definitions.
409ConflictIDEMPOTENCY_KEY_REUSEDapplication/json
The key was already used in the last 24 hours with a different request body.
422Validation failedVALIDATION_FAILEDapplication/json
The payload broke a rule, and error.fields maps each offending key to its messages. A refusal from the domain, such as a role code already taken or a team the caller does not own, uses the same code with error.message saying why and no fields.
On this endpoint: VALIDATION_FAILED: when a row has no text, a text is longer than two hundred characters, or more than thirty rows are sent.
425Too earlyIDEMPOTENCY_REPLAY_IN_PROGRESSapplication/json
The first request with this key is still running; retry in a few seconds and the original response is replayed.
429Too many requestsRATE_LIMITEDapplication/json
The token has spent its 300 requests a minute or 10,000 an hour; Retry-After says when the next one is accepted.
How is this guide?
Last updated on