agency-board

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

Rename a board or attach a client organisation to it.

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

Attaching a client to a board that has none is always allowed — that is how a board created for internal work becomes a client's board. ⛔ **Changing or clearing a client that is already attached is refused with a `422` once the client has seen anything on the board** — a client-visible card, a question asked of them, or one of their people invited to it. Re-pointing such a board would hand a second client the first one's brief, answers and complaints through a screen whose whole promise is that a client sees only what the agency shared. Archive the board and start a new one for the other client. Sending the client id the board already holds is not a change and is never refused, so a rename carrying the whole form still works.

Parameter

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

Isi permintaan

Nama	Jenis	Wajib	Tentang apa ini
`name`	`string`	Tidak	—
`description`	`string`	Tidak	—
`client_org_id`	`string`	Tidak	—

Tanggapan

Nama	Jenis	Wajib	Tentang apa ini
`id`	`Uuid`	Ya	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`org_id`	`Uuid`	Ya	The agency that owns this board.
`client_org_id`	`string`	Tidak	The client organisation this board's work is for, if any. This is what authorises a client's read — never the org tree, because "is a descendant of the agency" is a weaker claim…
`client_org_name`	`string`	Tidak	That client organisation's name, resolved by the engine. `client_org_id` set with this `null` is a real state and not an error — the board names a client the caller may not read…
`name`	`string`	Ya	—
`description`	`string`	Tidak	—
`archived_at`	`string`	Tidak	—
`open_question_count`	`integer`	Tidak	—
`created_at`	`string`	Ya	—
`updated_at`	`string`	Tidak	—
`created_by`	`AgencyBoardActor`	Tidak	Who created the board. `null` if that account no longer exists.
`updated_by`	`AgencyBoardActor`	Tidak	Who last changed the board itself — its name, description or client organisation. ⛔ NOT "who last touched anything on it": that is the activity feed. It moves exactly when `upda…

Kesalahan yang dapat dikembalikan oleh titik akhir ini

401 · 403 · 404 · 422

PATCH /v1/agency/boards/{boardId}