agency-board

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

Tick or un-tick one checklist item.

Аутентификација

Пошаљите API кључ као bearer токен. Ова крајња тачка не наводи конкретну дозволу у спецификацији, па свом кључу доделите најмања неопходна овлашћења и проверите одговор уместо да претпостављате.

Ова крајња тачка не прихвата id организације. Ваш кључ већ идентификује организацију којој припада, а одговор је ограничен на њу.

Испробајте

Замените све што је у угластим заградама сопственим вредностима, а чувар места кључа кључем са своје контролне табле.

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

Пријављени сте? API конзола на вашој контролној табли попуњава ваш прави id организације и ваш сопствени кључ, и покреће захтев према живом API-ју како бисте могли да видите стварни одговор. Отворите ову крајњу тачку у API конзоли

Детаљи

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

Параметри

Назив	Тип	Обавезно	Шта је ово
`boardId (path)`	`Uuid`	Да	Project board ID (UUIDv7).
`cardId (path)`	`Uuid`	Да	Board card ID (UUIDv7).
`itemId (path)`	`Uuid`	Да	Board checklist item ID (UUIDv7).

Тело захтева

Назив	Тип	Обавезно	Шта је ово
`done`	`boolean`	Да	—

Одговор

Назив	Тип	Обавезно	Шта је ово
`id`	`Uuid`	Да	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`card_id`	`Uuid`	Да	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`text`	`string`	Да	—
`position`	`integer`	Да	—
`done_at`	`string`	Не	When it was ticked. `null` means outstanding.
`done_by`	`AgencyBoardActor`	Не	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`	Не	—

Грешке које ова крајња тачка може вратити

401 · 403 · 404 · 422

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