agency-board

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

Rename a board or attach a client organisation to it.

אימות

שלח מפתח API כטוקן Bearer. נקודת קצה זו אינה מציינת הרשאת ספציפית במפרט, לכן הקצה למפתח שלך את המינימום הנדרש ובדוק את התגובה במקום להניח הנחות.

נקודת קצה זו אינה דורשת מזהה ארגון. המפתח שלך כבר מזהה את הארגון שאליו הוא שייך, והתגובה מוגבלת אליו בלבד.

נסה זאת

החלף כל דבר בסוגריים זוויתיים בערכים משלך, ואת מציין מיקום המפתח במפתח מלוח הבקרה שלך.

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

מחובר? קונסולת ה-API בלוח הבקרה שלך מזינה את מזהה הארגון האמיתי שלך ואת המפתח שלך, ומריצה את הבקשה מול ה-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`	לא	—
`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 `upda…

שגיאות שנקודה קצה זו עשויה להחזיר

401 · 403 · 404 · 422

PATCH /v1/agency/boards/{boardId}