agency-board

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

Tick or un-tick one checklist item.

Autentifikimi

Drgoni një çelës API si një token mbajtës. Ky pikëndalim nuk specifikon një leje specifike në specifikim, prandaj jepini çelësit tuaj minimumin e nevojshëm dhe kontrolloni përgjigjen në vend që të supozoni.

Ky pikëndalim nuk pranon id të organizatës. Çelësi juaj tashmë identifikon organizatën së cilës i përket dhe përgjigjja kufizohet vetëm për atë.

Provoje

Zëvendësoni çdo gjë brenda kllapave këndore me vlerat tuaja dhe vendbanuesin e çelësit me një çelës nga paneli juaj.

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

Jeni kyçur? Konsola e API-së në panelin tuaj plotëson ID-në tuaj reale të organizatës dhe çelësin tuaj, dhe ekzekuton kërkesën kundrejt API-së live, kështu që ju mund të shihni përgjigjen aktuale. Hapni këtë pikë fundore në konsolën e API-së

Detajet

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

Parametrat

Emri	Lloji	Kërkohet	Çfarë është kjo
`boardId (path)`	`Uuid`	Po	Project board ID (UUIDv7).
`cardId (path)`	`Uuid`	Po	Board card ID (UUIDv7).
`itemId (path)`	`Uuid`	Po	Board checklist item ID (UUIDv7).

Trupi i kërkesës

Emri	Lloji	Kërkohet	Çfarë është kjo
`done`	`boolean`	Po	—

Përgjigja

Emri	Lloji	Kërkohet	Çfarë është kjo
`id`	`Uuid`	Po	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`card_id`	`Uuid`	Po	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`text`	`string`	Po	—
`position`	`integer`	Po	—
`done_at`	`string`	Jo	When it was ticked. `null` means outstanding.
`done_by`	`AgencyBoardActor`	Jo	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`	Jo	—

Gabimet që ky pikëndalim mund të kthejë

401 · 403 · 404 · 422

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