agency-board

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

Tick or un-tick one checklist item.

Autentikasi

Kirimkan kunci API sebagai token bearer. Titik akhir ini tidak menyatakan izin tertentu dalam spesifikasi, jadi berikan kunci Anda izin minimum yang diperlukan dan periksa responsnya alih-alih berasumsi.

Endpoint ini tidak memerlukan id organisasi. Kunci Anda telah mengidentifikasi organisasi tempatnya berafiliasi, dan respons akan dibatasi untuk organisasi tersebut.

Coba

Ganti apa pun di dalam tanda kurung sudut dengan nilai Anda sendiri, dan placeholder kunci dengan kunci dari dasbor Anda.

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

Sudah masuk? Konsol API di dasbor Anda akan mengisi ID organisasi asli dan kunci Anda sendiri, serta menjalankan permintaan terhadap API langsung sehingga Anda dapat melihat respons aktualnya. Buka titik akhir ini di konsol API

Detail

⛔ 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

Nama	Jenis	Wajib	Tentang apa ini
`boardId (path)`	`Uuid`	Ya	Project board ID (UUIDv7).
`cardId (path)`	`Uuid`	Ya	Board card ID (UUIDv7).
`itemId (path)`	`Uuid`	Ya	Board checklist item ID (UUIDv7).

Isi permintaan

Nama	Jenis	Wajib	Tentang apa ini
`done`	`boolean`	Ya	—

Tanggapan

Nama	Jenis	Wajib	Tentang apa ini
`id`	`Uuid`	Ya	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`card_id`	`Uuid`	Ya	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`text`	`string`	Ya	—
`position`	`integer`	Ya	—
`done_at`	`string`	Tidak	When it was ticked. `null` means outstanding.
`done_by`	`AgencyBoardActor`	Tidak	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`	Tidak	—

Kesalahan yang dapat dikembalikan oleh titik akhir ini

401 · 403 · 404 · 422

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