agency-board

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

Tick or un-tick one checklist item.

Autentizace

Odešlete klíč API jako bearer token. Tento koncový bod ve specifikaci uvádí specifické oprávnění, takže svému klíči udělte to nejmenší možné a místo předpokladů zkontrolujte odpověď.

Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.

Vyzvednout

Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.

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

Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API

Podrobnosti

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

Parametry

Název	Typ	Požadováno	Co to je
`boardId (path)`	`Uuid`	Ano	Project board ID (UUIDv7).
`cardId (path)`	`Uuid`	Ano	Board card ID (UUIDv7).
`itemId (path)`	`Uuid`	Ano	Board checklist item ID (UUIDv7).

Tělo požadavku

Název	Typ	Požadováno	Co to je
`done`	`boolean`	Ano	—

Odpověď

Název	Typ	Požadováno	Co to je
`id`	`Uuid`	Ano	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`card_id`	`Uuid`	Ano	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`text`	`string`	Ano	—
`position`	`integer`	Ano	—
`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	—

Chyby, které může tento koncový bod vrátit

401 · 403 · 404 · 422

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