agency-board

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

Rename a board or attach a client organisation to it.

Pagpapatotoo

Magpadala ng API key bilang bearer token. Ang endpoint na ito ay hindi naglatag ng tiyak na pahintulot sa pagtutukoy, kaya ibigay sa iyong key ang pinakamababang kailangan nito at suriin ang tugon sa halip na umasa.

Ang endpoint na ito ay hindi nangangailangan ng id ng organisasyon. Natutukoy na ng iyong key ang organisasyong kinabibilangan nito, at nakatuon ang tugon dito.

Subukan ito

Palitan ang anuman sa loob ng mga panaklong na may anggulo ng iyong sariling mga halaga, at ang placeholder ng key na may key mula sa iyong dashboard.

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

Nakalagda? Ang API console sa iyong dashboard ay awtomatikong naglalagay ng iyong tunay na ID ng organisasyon at sariling susi, at pinapatakbo ang kahilingan laban sa live na API upang makita mo ang aktwal na tugon. Buksan ang endpoint na ito sa console ng API

Mga Detalye

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.

Mga Parameter

Pangalan	Uri	Kailangan	Ano ito
`boardId (path)`	`Uuid`	Oo	Project board ID (UUIDv7).

Katawan ng kahilingan

Pangalan	Uri	Kailangan	Ano ito
`name`	`string`	Hindi	—
`description`	`string`	Hindi	—
`client_org_id`	`string`	Hindi	—

Tugon

Pangalan	Uri	Kailangan	Ano ito
`id`	`Uuid`	Oo	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`org_id`	`Uuid`	Oo	The agency that owns this board.
`client_org_id`	`string`	Hindi	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`	Hindi	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`	Oo	—
`description`	`string`	Hindi	—
`archived_at`	`string`	Hindi	—
`open_question_count`	`integer`	Hindi	—
`created_at`	`string`	Oo	—
`updated_at`	`string`	Hindi	—
`created_by`	`AgencyBoardActor`	Hindi	Who created the board. `null` if that account no longer exists.
`updated_by`	`AgencyBoardActor`	Hindi	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…

Mga error na maibabalik ng endpoint na ito

401 · 403 · 404 · 422

PATCH /v1/agency/boards/{boardId}