agency-board

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

Tick or un-tick one checklist item.

Hitelesítés

Küldjön egy API-kulcsot bearer tokenként. Ez a végpont nem határoz meg konkrét jogosultságot a specifikációban, ezért adja meg a kulcsnak a legkevesebbet, amire szüksége van, és a feltételezés helyett ellenőrizze a választ.

Ez a végpont nem fogad el szervezeti azonosítót. Az Ön kulcsa már azonosítja azt a szervezetet, amelyhez tartozik, és a válasz is erre vonatkozik.

Próbálja ki

Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.

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> }'

Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban

Részletek

⛔ 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.

Paraméterek

Név	Típus	Kötelező	Mi ez
`boardId (path)`	`Uuid`	Igen	Project board ID (UUIDv7).
`cardId (path)`	`Uuid`	Igen	Board card ID (UUIDv7).
`itemId (path)`	`Uuid`	Igen	Board checklist item ID (UUIDv7).

Kérés törzse

Név	Típus	Kötelező	Mi ez
`done`	`boolean`	Igen	—

Válasz

Név	Típus	Kötelező	Mi ez
`id`	`Uuid`	Igen	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`card_id`	`Uuid`	Igen	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`text`	`string`	Igen	—
`position`	`integer`	Igen	—
`done_at`	`string`	Nem	When it was ticked. `null` means outstanding.
`done_by`	`AgencyBoardActor`	Nem	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`	Nem	—

Hibák, amelyeket ez a végpont visszaadhattatlan

401 · 403 · 404 · 422

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