agency-board

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

Edit a card.

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} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

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

⭐ Sending `assignee_id: null` **unassigns**; omitting the field leaves the assignee alone. The two are different requests and the API distinguishes them, because a `null`-means-absent API cannot express "unassign" at all.

Parametri

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

Corpo della richiesta

Nome	Tipo	Obbligatorio	Che cos'è
`title`	`string`	No	—
`body`	`string`	No	—
`visibility`	`AgencyBoardVisibility`	No	Who may see this object. `internal` is always the default. A card reaches the client only when it is `client` and its column is too — an AND, not inheritance, because th…
`assignee_id`	`string`	No	—
`due_at`	`string`	No	—
`cover_colour`	`string<neutral, info, violet, ok, warn, crit, >`	No	A palette token, or the empty string to clear the cover. ⛔ The empty string is the CLEAR rather than `null`, so there is exactly one spelling of "no cover".

Risposta

Nome	Tipo	Obbligatorio	Che cos'è
`id`	`Uuid`	Sì	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`board_id`	`Uuid`	Sì	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`column_id`	`Uuid`	Sì	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`title`	`string`	Sì	—
`body`	`string`	No	—
`visibility`	`AgencyBoardVisibility`	Sì	Who may see this object. `internal` is always the default. A card reaches the client only when it is `client` and its column is too — an AND, not inheritance, because th…
`position`	`integer`	Sì	—
`assignee_id`	`string`	No	—
`due_at`	`string`	No	—
`created_by_client`	`boolean`	No	Whether the client raised this card themselves.
`archived_at`	`string`	No	—
`cover_colour`	`AgencyBoardLabelColour`	No	A colour band across the top of the card, or the empty string for none. ⛔ Shares the label palette rather than declaring a second one: two palettes on one screen is how a cover…
`labels`	`AgencyBoardLabel[]`	No	The labels this card wears, in the board's label order. ⛔ Agency-only — the client's projection of a card carries no labels at all, because a label is the agency's private vocab…
`created_at`	`string`	No	—
`updated_at`	`string`	No	—

Errori che questo endpoint può restituire

401 · 403 · 404 · 422

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