agency-board
POST /v1/agency/boards/{boardId}/members
Put somebody on a board, or invite them by email.
Hitelesítés
Küldjön egy API-kulcsot bearer tokenként. Ez a végpont nem határoz meg konkrét jogosultságot a specifikációban, ezért adja meg a kulcsnak a legkevesebbet, amire szüksége van, és a feltételezés helyett ellenőrizze a választ.
Ez a végpont nem fogad el szervezeti azonosítót. Az Ön kulcsa már azonosítja azt a szervezetet, amelyhez tartozik, és a válasz is erre vonatkozik.
Próbálja ki
Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.
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>> }'Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban
Részletek
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.
Paraméterek
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
boardId (path) | Uuid | Igen | Project board ID (UUIDv7). |
Kérés törzse
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
user_id | string | Nem | Somebody who already has an account. Give this **or** `email`, not both. |
email | string | Nem | Invite somebody who does not have an account yet. |
role | string<manager, member, client> | Igen | — |
member_org_id | string | Nem | Which organisation this seat belongs to. Ignored for a `client` seat, which is always the board's own client organisation. |
Válasz
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
id | Uuid | Igen | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
board_id | Uuid | Igen | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
user_id | Uuid | Igen | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
member_org_id | Uuid | Igen | The organisation this seat belongs to — the agency's, or the client's. |
role | string<manager, member, client> | Igen | — |
last_read_at | string | Nem | — |
created_at | string | Nem | — |
user | AgencyBoardActor | Nem | 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 | Nem | — |
Hibák, amelyeket ez a végpont visszaadhattatlan
401 · 403 · 404 · 422