agency-board

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

Rename a board or attach a client organisation to it.

Autentificare

Trimiteți o cheie API ca token de tip bearer. Acest punct final nu specifică o permisiune anume în specificație, așa că acordați cheii cele mai puține drepturi necesare și verificați răspunsul în loc să faceți presupuneri.

Acest endpoint nu necesită un ID de organizație. Cheia ta identifică deja organizația căreia îi aparține, iar răspunsul este limitat la aceasta.

Încearcă

Înlocuiți tot ce se află între paranteze unghiulare cu propriile valori și substituentul cheie cu o cheie din tabloul de bord.

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

Autentificat? Consola API din panoul de control îți completează ID-ul real al organizației și propria cheie și rulează cererea în API-ul live, astfel încât să poți vedea răspunsul efectiv. Deschideți acest punct final în consola API

Detalii

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.

Parametri

Nume	Tip	Obligatoriu	Ce este
`boardId (path)`	`Uuid`	Da	Project board ID (UUIDv7).

Corp cerere

Nume	Tip	Obligatoriu	Ce este
`name`	`string`	Nu	—
`description`	`string`	Nu	—
`client_org_id`	`string`	Nu	—

Răspuns

Nume	Tip	Obligatoriu	Ce este
`id`	`Uuid`	Da	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`org_id`	`Uuid`	Da	The agency that owns this board.
`client_org_id`	`string`	Nu	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`	Nu	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`	Da	—
`description`	`string`	Nu	—
`archived_at`	`string`	Nu	—
`open_question_count`	`integer`	Nu	—
`created_at`	`string`	Da	—
`updated_at`	`string`	Nu	—
`created_by`	`AgencyBoardActor`	Nu	Who created the board. `null` if that account no longer exists.
`updated_by`	`AgencyBoardActor`	Nu	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…

Erori pe care le poate returna acest punct final

401 · 403 · 404 · 422

PATCH /v1/agency/boards/{boardId}