agency-board

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

Tick or un-tick one checklist item.

Xác thực

Gửi khóa API dưới dạng mã thông báo bearer. Điểm cuối này không nêu rõ quyền cụ thể trong thông số kỹ thuật, vì vậy hãy cấp cho khóa của bạn quyền tối thiểu cần thiết và kiểm tra phản hồi thay vì phỏng đoán.

Endpoint này không nhận ID tổ chức. Khóa của bạn đã xác định tổ chức mà nó thuộc về và phản hồi được giới hạn trong phạm vi đó.

Dùng thử

Thay thế bất kỳ nội dung nào trong ngoعل (angle brackets) bằng giá trị của riêng bạn và trình giữ chỗ key bằng một key từ trang tổng quan của bạn.

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

Đã đăng nhập? Bảng điều khiển API trong trang quản lý của bạn sẽ tự điền ID tổ chức thực tế và khóa của riêng bạn, sau đó chạy yêu cầu đối với API trực tiếp để bạn có thể xem phản hồi thực tế. Mở điểm cuối này trong bảng điều khiển API

Chi tiết

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

Tham số

Tên	Loại	Bắt buộc	Nội dung này là gì
`boardId (path)`	`Uuid`	Có	Project board ID (UUIDv7).
`cardId (path)`	`Uuid`	Có	Board card ID (UUIDv7).
`itemId (path)`	`Uuid`	Có	Board checklist item ID (UUIDv7).

Nội dung yêu cầu

Tên	Loại	Bắt buộc	Nội dung này là gì
`done`	`boolean`	Có	—

Phản hồi

Tên	Loại	Bắt buộc	Nội dung này là gì
`id`	`Uuid`	Có	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`card_id`	`Uuid`	Có	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`text`	`string`	Có	—
`position`	`integer`	Có	—
`done_at`	`string`	Không	When it was ticked. `null` means outstanding.
`done_by`	`AgencyBoardActor`	Không	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`	Không	—

Các lỗi điểm cuối này có thể trả về

401 · 403 · 404 · 422

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