agency-board

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

Tick or un-tick one checklist item.

Kimlik Doğrulama

Bir API anahtarını bearer token olarak gönderin. Bu uç nokta, teknik özelliklerde belirli bir yetki belirtmemektedir; bu nedenle, varsaymak yerine anahtarınıza ihtiyaç duyduğu en az yetkiyi verin ve yanıtı kontrol edin.

Bu uç nokta hiçbir organizasyon kimliği almaz. Anahtarınız zaten ait olduğu organizasyonu tanımlar ve yanıt bu organizasyonla sınırlandırılır.

Dene

Köşeli parantez içindeki her şeyi kendi değerlerinizle ve anahtar yer tutucusunu panonuzdan bir anahtarla değiştirin.

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

Oturum açtınız mı? Panonuzdaki API konsolu, gerçek organizasyon kimliğinizi ve kendi anahtarınızı otomatik olarak doldurur ve isteği canlı API üzerinde çalıştırarak gerçek yanıtı görmenizi sağlar. Bu uç noktayı API konsolunda açın

Ayrıntılar

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

Parametreler

Ad	Tür	Zorunlu	Ne olduğu
`boardId (path)`	`Uuid`	Evet	Project board ID (UUIDv7).
`cardId (path)`	`Uuid`	Evet	Board card ID (UUIDv7).
`itemId (path)`	`Uuid`	Evet	Board checklist item ID (UUIDv7).

İstek gövdesi

Ad	Tür	Zorunlu	Ne olduğu
`done`	`boolean`	Evet	—

Yanıt

Ad	Tür	Zorunlu	Ne olduğu
`id`	`Uuid`	Evet	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`card_id`	`Uuid`	Evet	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`text`	`string`	Evet	—
`position`	`integer`	Evet	—
`done_at`	`string`	Hayır	When it was ticked. `null` means outstanding.
`done_by`	`AgencyBoardActor`	Hayır	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`	Hayır	—

Bu uç noktanın dönderebileceği hatalar

401 · 403 · 404 · 422

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