agency-board

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

Rename a board or attach a client organisation to it.

Аутентификација

Пошаљите API кључ као bearer токен. Ова крајња тачка не наводи конкретну дозволу у спецификацији, па свом кључу доделите најмања неопходна овлашћења и проверите одговор уместо да претпостављате.

Ова крајња тачка не прихвата id организације. Ваш кључ већ идентификује организацију којој припада, а одговор је ограничен на њу.

Испробајте

Замените све што је у угластим заградама сопственим вредностима, а чувар места кључа кључем са своје контролне табле.

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

Пријављени сте? API конзола на вашој контролној табли попуњава ваш прави id организације и ваш сопствени кључ, и покреће захтев према живом API-ју како бисте могли да видите стварни одговор. Отворите ову крајњу тачку у API конзоли

Детаљи

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.

Параметри

Назив	Тип	Обавезно	Шта је ово
`boardId (path)`	`Uuid`	Да	Project board ID (UUIDv7).

Тело захтева

Назив	Тип	Обавезно	Шта је ово
`name`	`string`	Не	—
`description`	`string`	Не	—
`client_org_id`	`string`	Не	—

Одговор

Назив	Тип	Обавезно	Шта је ово
`id`	`Uuid`	Да	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`org_id`	`Uuid`	Да	The agency that owns this board.
`client_org_id`	`string`	Не	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`	Не	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`	Да	—
`description`	`string`	Не	—
`archived_at`	`string`	Не	—
`open_question_count`	`integer`	Не	—
`locked`	`object`	Не	Why this board cannot be opened right now — the owning organisation's plan no longer includes project boards — as the same MACHINE CODE and plan name `create_blocked` carries, or…
`created_at`	`string`	Да	—
`updated_at`	`string`	Не	—
`created_by`	`AgencyBoardActor`	Не	Who created the board. `null` if that account no longer exists.
`updated_by`	`AgencyBoardActor`	Не	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…

Грешке које ова крајња тачка може вратити

401 · 403 · 404 · 422

PATCH /v1/agency/boards/{boardId}