agency-board

POST `/v1/agency/boards/{boardId}/members`

Put somebody on a board, or invite them by email.

אימות

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

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

נסה זאת

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

curl -X POST https://api.zinndigital.com/v1/agency/boards/{boardId}/members \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "role": <string<manager, member, client>> }'

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

פרטים

Give `user_id` for somebody who already has an account, or `email` to invite somebody who does not — the invitation goes through `tenancy.Invitation` and the person joins on acceptance, authenticated by Keycloak with no secret token in the flow. ⛔ A `client` seat may only be given to a member of the board's own client organisation, and **no seat is written for a pending invite**: a client's authorisation is a live membership of that organisation, re-read on every request, so a seat created before acceptance would look like access and confer none.

פרמטרים

שם	סוג	נדרש	מה זה
`boardId (path)`	`Uuid`	כן	Project board ID (UUIDv7).

גוף הבקשה

שם	סוג	נדרש	מה זה
`user_id`	`string`	לא	Somebody who already has an account. Give this or `email`, not both.
`email`	`string`	לא	Invite somebody who does not have an account yet.
`role`	`string<manager, member, client>`	כן	—
`member_org_id`	`string`	לא	Which organisation this seat belongs to. Ignored for a `client` seat, which is always the board's own client organisation.

תשובה

שם	סוג	נדרש	מה זה
`id`	`Uuid`	כן	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`board_id`	`Uuid`	כן	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`user_id`	`Uuid`	כן	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`member_org_id`	`Uuid`	כן	The organisation this seat belongs to — the agency's, or the client's.
`role`	`string<manager, member, client>`	כן	—
`last_read_at`	`string`	לא	—
`created_at`	`string`	לא	—
`user`	`AgencyBoardActor`	לא	Who holds this seat, by name. ⛔ Render THIS, never `user_id` — the People drawer printed the id at a colleague's name until 2026-09-01 (`docs/425`).
`invited_by`	`AgencyBoardActor`	לא	—

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

401 · 403 · 404 · 422

POST /v1/agency/boards/{boardId}/members