agency-board

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

Tick or un-tick one checklist item.

Autenticazione

Invia una chiave API come bearer token. Questo endpoint non specifica un permesso specifico nella specifica, quindi assegna alla tua chiave i permessi minimi necessari e verifica la risposta invece di fare supposizioni.

Questo endpoint non richiede alcun ID organizzazione. La tua chiave identifica già l'organizzazione a cui appartiene e la risposta è limitata ad essa.

Provalo

Sostituisci qualsiasi elemento tra parentesi angolari con i tuoi valori e il segnaposto key con una chiave dalla tua dashboard.

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

Hai effettuato l'accesso? La console API nella tua dashboard inserisce il tuo ID organizzazione reale e la tua chiave personale, ed esegue la richiesta sull'API live in modo da poter vedere la risposta effettiva. Apri questo endpoint nella console API

Dettagli

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

Parametri

Nome	Tipo	Obbligatorio	Che cos'è
`boardId (path)`	`Uuid`	Sì	Project board ID (UUIDv7).
`cardId (path)`	`Uuid`	Sì	Board card ID (UUIDv7).
`itemId (path)`	`Uuid`	Sì	Board checklist item ID (UUIDv7).

Corpo della richiesta

Nome	Tipo	Obbligatorio	Che cos'è
`done`	`boolean`	Sì	—

Risposta

Nome	Tipo	Obbligatorio	Che cos'è
`id`	`Uuid`	Sì	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`card_id`	`Uuid`	Sì	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`text`	`string`	Sì	—
`position`	`integer`	Sì	—
`done_at`	`string`	No	When it was ticked. `null` means outstanding.
`done_by`	`AgencyBoardActor`	No	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`	No	—

Errori che questo endpoint può restituire

401 · 403 · 404 · 422

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