agency-board

PATCH `/v1/agency/boards/{boardId}/cards/{cardId}/checklist/{itemId}`

Tick or un-tick one checklist item.

Authenticatie

Stuur een API-sleutel mee als bearer token. Dit eindpunt vermeldt geen specifieke toestemming in de specificatie, dus geef uw sleutel de minimale rechten die nodig zijn en controleer het antwoord in plaats van zomaar wat aan te nemen.

Dit eindpunt vereist geen organisatie-id. Uw sleutel identificeert al de organisatie waartoe deze behoort, en het antwoord is hierop afgestemd.

Probeer het

Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw dashboard.

curl -X PATCH https://api.zinndigital.com/v1/agency/boards/{boardId}/cards/{cardId}/checklist/{itemId} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "done": <boolean> }'

Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de API-console

Details

⛔ Idempotent, and it records nothing on the board's timeline when the state already matches. A checkbox re-sending its state would otherwise read as "ticked Deploy, 6 times" for one tick. ⭐ `done_by` is kept when an item is un-ticked. "Who ticked this and then un-ticked it" is a question an agency gets asked by its client, and clearing the field makes it unanswerable while looking tidier.

Parameters

Naam	Type	Verplicht	Wat dit is
`boardId (path)`	`Uuid`	Ja	Project board ID (UUIDv7).
`cardId (path)`	`Uuid`	Ja	Board card ID (UUIDv7).
`itemId (path)`	`Uuid`	Ja	Board checklist item ID (UUIDv7).

Aanvraaglichaam

Naam	Type	Verplicht	Wat dit is
`done`	`boolean`	Ja	—

Reactie

Naam	Type	Verplicht	Wat dit is
`id`	`Uuid`	Ja	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`card_id`	`Uuid`	Ja	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`text`	`string`	Ja	—
`position`	`integer`	Ja	—
`done_at`	`string`	Nee	When it was ticked. `null` means outstanding.
`done_by`	`AgencyBoardActor`	Nee	Who ticked it. ⛔ Kept when the item is un-ticked as well, so "Sam ticked this and then un-ticked it" stays answerable.
`created_at`	`string`	Nee	—

Fouten die dit eindpunt kan retourneren

401 · 403 · 404 · 422

PATCH /v1/agency/boards/{boardId}/cards/{cardId}/checklist/{itemId}