agency-board
POST /v1/agency/boards/{boardId}/members
Put somebody on a board, or invite them by email.
Pagpapatotoo
Magpadala ng API key bilang bearer token. Ang endpoint na ito ay hindi naglatag ng tiyak na pahintulot sa pagtutukoy, kaya ibigay sa iyong key ang pinakamababang kailangan nito at suriin ang tugon sa halip na umasa.
Ang endpoint na ito ay hindi nangangailangan ng id ng organisasyon. Natutukoy na ng iyong key ang organisasyong kinabibilangan nito, at nakatuon ang tugon dito.
Subukan ito
Palitan ang anuman sa loob ng mga panaklong na may anggulo ng iyong sariling mga halaga, at ang placeholder ng key na may key mula sa iyong dashboard.
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>> }'Nakalagda? Ang API console sa iyong dashboard ay awtomatikong naglalagay ng iyong tunay na ID ng organisasyon at sariling susi, at pinapatakbo ang kahilingan laban sa live na API upang makita mo ang aktwal na tugon. Buksan ang endpoint na ito sa console ng API
Mga Detalye
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.
Mga Parameter
| Pangalan | Uri | Kailangan | Ano ito |
|---|---|---|---|
boardId (path) | Uuid | Oo | Project board ID (UUIDv7). |
Katawan ng kahilingan
| Pangalan | Uri | Kailangan | Ano ito |
|---|---|---|---|
user_id | string | Hindi | Somebody who already has an account. Give this **or** `email`, not both. |
email | string | Hindi | Invite somebody who does not have an account yet. |
role | string<manager, member, client> | Oo | — |
member_org_id | string | Hindi | Which organisation this seat belongs to. Ignored for a `client` seat, which is always the board's own client organisation. |
Tugon
| Pangalan | Uri | Kailangan | Ano ito |
|---|---|---|---|
id | Uuid | Oo | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
board_id | Uuid | Oo | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
user_id | Uuid | Oo | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
member_org_id | Uuid | Oo | The organisation this seat belongs to — the agency's, or the client's. |
role | string<manager, member, client> | Oo | — |
last_read_at | string | Hindi | — |
created_at | string | Hindi | — |
user | AgencyBoardActor | Hindi | 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 | Hindi | — |
Mga error na maibabalik ng endpoint na ito
401 · 403 · 404 · 422