agency-board
POST /v1/agency/boards/{boardId}/members
Put somebody on a board, or invite them by email.
Autentifikimi
Drgoni një çelës API si një token mbajtës. Ky pikëndalim nuk specifikon një leje specifike në specifikim, prandaj jepini çelësit tuaj minimumin e nevojshëm dhe kontrolloni përgjigjen në vend që të supozoni.
Ky pikëndalim nuk pranon id të organizatës. Çelësi juaj tashmë identifikon organizatën së cilës i përket dhe përgjigjja kufizohet vetëm për atë.
Provoje
Zëvendësoni çdo gjë brenda kllapave këndore me vlerat tuaja dhe vendbanuesin e çelësit me një çelës nga paneli juaj.
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>> }'Jeni kyçur? Konsola e API-së në panelin tuaj plotëson ID-në tuaj reale të organizatës dhe çelësin tuaj, dhe ekzekuton kërkesën kundrejt API-së live, kështu që ju mund të shihni përgjigjen aktuale. Hapni këtë pikë fundore në konsolën e API-së
Detajet
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.
Parametrat
| Emri | Lloji | Kërkohet | Çfarë është kjo |
|---|---|---|---|
boardId (path) | Uuid | Po | Project board ID (UUIDv7). |
Trupi i kërkesës
| Emri | Lloji | Kërkohet | Çfarë është kjo |
|---|---|---|---|
user_id | string | Jo | Somebody who already has an account. Give this **or** `email`, not both. |
email | string | Jo | Invite somebody who does not have an account yet. |
role | string<manager, member, client> | Po | — |
member_org_id | string | Jo | Which organisation this seat belongs to. Ignored for a `client` seat, which is always the board's own client organisation. |
Përgjigja
| Emri | Lloji | Kërkohet | Çfarë është kjo |
|---|---|---|---|
id | Uuid | Po | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
board_id | Uuid | Po | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
user_id | Uuid | Po | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
member_org_id | Uuid | Po | The organisation this seat belongs to — the agency's, or the client's. |
role | string<manager, member, client> | Po | — |
last_read_at | string | Jo | — |
created_at | string | Jo | — |
user | AgencyBoardActor | Jo | 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 | Jo | — |
Gabimet që ky pikëndalim mund të kthejë
401 · 403 · 404 · 422