agency-board

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

Rename a board or attach a client organisation to it.

Doğrulama

API açarını bearer token kimi göndərin. Bu səhifə spresifikasiyada xüsusi icazə tələb etmir, buna görə də açarınıza ehtiyac duyduğu minimum səviyyədə icazə verin və güman etmək əvəzinə cavabı yoxlayın.

Bu endpoint heç bir təşkilat ID-si tələb etmir. Sizin açarınız artıq aid olduğu təşkilatı müəyyən edir və cavab həmin təşkilat üçün məhdudlaşdırılır.

Sınaqdan keçir

Bucaqlı mötərizələrdə olan hór şeyi öz qiymətlərinizlə, açar yertutucusunu isə idarə panelinizdən bir açarla əvəz edin.

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

Sistemə daxil olmusunuz? İdarə panelinizdəki API konsolu real təşkilatınızın identifikatorunu və öz açarınızı avtomatik doldurur, sorğunu canlı API-yə qarşı icra edir ki, siz faktiki cavabı görə biləsiniz. Bu son nöqtəni API konsolunda açın

Təfərrüatlar

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.

Parametrlər

Ad	Tip	Tələb olunur	Nədir
`boardId (path)`	`Uuid`	Bəli	Project board ID (UUIDv7).

Sorğu gövdəsi

Ad	Tip	Tələb olunur	Nədir
`name`	`string`	Xeyr	—
`description`	`string`	Xeyr	—
`client_org_id`	`string`	Xeyr	—

Cavab

Ad	Tip	Tələb olunur	Nədir
`id`	`Uuid`	Bəli	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`org_id`	`Uuid`	Bəli	The agency that owns this board.
`client_org_id`	`string`	Xeyr	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`	Xeyr	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`	Bəli	—
`description`	`string`	Xeyr	—
`archived_at`	`string`	Xeyr	—
`open_question_count`	`integer`	Xeyr	—
`created_at`	`string`	Bəli	—
`updated_at`	`string`	Xeyr	—
`created_by`	`AgencyBoardActor`	Xeyr	Who created the board. `null` if that account no longer exists.
`updated_by`	`AgencyBoardActor`	Xeyr	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…

Bu son nöqtənin qaytara biləcəyi xətalar

401 · 403 · 404 · 422

PATCH /v1/agency/boards/{boardId}