agency-board

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

Tick or un-tick one checklist item.

Authentifizierung

Senden Sie einen API-Schlüssel als Bearer-Token. Dieser Endpunkt gibt in der Spezifikation keine spezifische Berechtigung an. Versehen Sie Ihren Schlüssel daher mit den minimal erforderlichen Rechten und prüfen Sie die Antwort, anstatt Annahmen zu treffen.

Dieser Endpunkt erfordert keine Organisations-ID. Ihr Schlüssel identifiziert bereits die zugehörige Organisation, und die Antwort ist entsprechend eingeschränkt.

Ausprobieren

Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem 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> }'

Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole

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.

Parameter

Name	Typ	Erforderlich	Was es ist
`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).

Anfragekörper

Name	Typ	Erforderlich	Was es ist
`done`	`boolean`	Ja	—

Antwort

Name	Typ	Erforderlich	Was es ist
`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`	Nein	When it was ticked. `null` means outstanding.
`done_by`	`AgencyBoardActor`	Nein	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`	Nein	—

Fehler, die dieser Endpunkt zurückgeben kann

401 · 403 · 404 · 422

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