agency-board

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

Edit a card.

Autentikasi

Kirimkan kunci API sebagai token bearer. Titik akhir ini tidak menyatakan izin tertentu dalam spesifikasi, jadi berikan kunci Anda izin minimum yang diperlukan dan periksa responsnya alih-alih berasumsi.

Endpoint ini tidak memerlukan id organisasi. Kunci Anda telah mengidentifikasi organisasi tempatnya berafiliasi, dan respons akan dibatasi untuk organisasi tersebut.

Coba

Ganti apa pun di dalam tanda kurung sudut dengan nilai Anda sendiri, dan placeholder kunci dengan kunci dari dasbor Anda.

curl -X PATCH https://api.zinndigital.com/v1/agency/boards/{boardId}/cards/{cardId} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

Sudah masuk? Konsol API di dasbor Anda akan mengisi ID organisasi asli dan kunci Anda sendiri, serta menjalankan permintaan terhadap API langsung sehingga Anda dapat melihat respons aktualnya. Buka titik akhir ini di konsol API

Detail

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

Parameter

Nama	Jenis	Wajib	Tentang apa ini
`boardId (path)`	`Uuid`	Ya	Project board ID (UUIDv7).
`cardId (path)`	`Uuid`	Ya	Board card ID (UUIDv7).

Isi permintaan

Nama	Jenis	Wajib	Tentang apa ini
`title`	`string`	Tidak	—
`body`	`string`	Tidak	—
`visibility`	`AgencyBoardVisibility`	Tidak	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`	Tidak	—
`due_at`	`string`	Tidak	—
`cover_colour`	`string<neutral, info, violet, ok, warn, crit, >`	Tidak	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".

Tanggapan

Nama	Jenis	Wajib	Tentang apa ini
`id`	`Uuid`	Ya	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`board_id`	`Uuid`	Ya	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`column_id`	`Uuid`	Ya	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`title`	`string`	Ya	—
`body`	`string`	Tidak	—
`visibility`	`AgencyBoardVisibility`	Ya	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`	Ya	—
`assignee_id`	`string`	Tidak	—
`due_at`	`string`	Tidak	—
`created_by_client`	`boolean`	Tidak	Whether the client raised this card themselves.
`archived_at`	`string`	Tidak	—
`cover_colour`	`AgencyBoardLabelColour`	Tidak	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[]`	Tidak	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`	Tidak	—
`updated_at`	`string`	Tidak	—

Kesalahan yang dapat dikembalikan oleh titik akhir ini

401 · 403 · 404 · 422

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