agency-board

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

Tick or un-tick one checklist item.

Autentifikacija

Pošaljite API ključ kao bearer token. Ova krajnja točka ne navodi određenu dozvolu u specifikaciji, stoga dajte svom ključu najmanje što mu je potrebno i provjerite odgovor umjesto da pretpostavljate.

Ova krajnja točka ne prihvaća ID organizacije. Vaš ključ već identificira organizaciju kojoj pripada, a odgovor je ograničen na nju.

Isprobajte

Zamijenite sve unutar šiljastih zagrada svojim vlastitim vrijednostima, a rezervirano mjesto za ključ s ključem iz vaše nadzorne ploče.

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

Prijavljeni ste? API konzola na vašoj nadzornoj ploči automatski unosi stvarni ID vaše organizacije i vaš vlastiti ključ te šalje zahtjev prema aktivnom API-ju kako biste mogli vidjeti stvarni odgovor. Otvori ovu krajnju točku u API konzoli

Pojedinosti

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

Parametri

Naziv	Vrsta	Obavezno	Što je to
`boardId (path)`	`Uuid`	Da	Project board ID (UUIDv7).
`cardId (path)`	`Uuid`	Da	Board card ID (UUIDv7).
`itemId (path)`	`Uuid`	Da	Board checklist item ID (UUIDv7).

Tijelo zahtjeva

Naziv	Vrsta	Obavezno	Što je to
`done`	`boolean`	Da	—

Odgovor

Naziv	Vrsta	Obavezno	Što je to
`id`	`Uuid`	Da	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`card_id`	`Uuid`	Da	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`text`	`string`	Da	—
`position`	`integer`	Da	—
`done_at`	`string`	Ne	When it was ticked. `null` means outstanding.
`done_by`	`AgencyBoardActor`	Ne	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`	Ne	—

Pogreške koje ova krajnja točka može vratiti

401 · 403 · 404 · 422

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