agency-board

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

Rename a board or attach a client organisation to it.

Authenticatie

Stuur een API-sleutel mee als bearer token. Dit eindpunt vermeldt geen specifieke toestemming in de specificatie, dus geef uw sleutel de minimale rechten die nodig zijn en controleer het antwoord in plaats van zomaar wat aan te nemen.

Dit eindpunt vereist geen organisatie-id. Uw sleutel identificeert al de organisatie waartoe deze behoort, en het antwoord is hierop afgestemd.

Probeer het

Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw dashboard.

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

Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de API-console

Details

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.

Parameters

Naam	Type	Verplicht	Wat dit is
`boardId (path)`	`Uuid`	Ja	Project board ID (UUIDv7).

Aanvraaglichaam

Naam	Type	Verplicht	Wat dit is
`name`	`string`	Nee	—
`description`	`string`	Nee	—
`client_org_id`	`string`	Nee	—

Reactie

Naam	Type	Verplicht	Wat dit is
`id`	`Uuid`	Ja	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`org_id`	`Uuid`	Ja	The agency that owns this board.
`client_org_id`	`string`	Nee	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`	Nee	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`	Ja	—
`description`	`string`	Nee	—
`archived_at`	`string`	Nee	—
`open_question_count`	`integer`	Nee	—
`created_at`	`string`	Ja	—
`updated_at`	`string`	Nee	—
`created_by`	`AgencyBoardActor`	Nee	Who created the board. `null` if that account no longer exists.
`updated_by`	`AgencyBoardActor`	Nee	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…

Fouten die dit eindpunt kan retourneren

401 · 403 · 404 · 422

PATCH /v1/agency/boards/{boardId}