agency-board
POST /v1/agency/boards/{boardId}/members
Put somebody on a board, or invite them by email.
Authentifizierung
Senden Sie einen API-Schlüssel als Bearer-Token. Dieser Endpunkt gibt in der Spezifikation keine spezifische Berechtigung an. Versehen Sie Ihren Schlüssel daher mit den minimal erforderlichen Rechten und prüfen Sie die Antwort, anstatt Annahmen zu treffen.
Dieser Endpunkt erfordert keine Organisations-ID. Ihr Schlüssel identifiziert bereits die zugehörige Organisation, und die Antwort ist entsprechend eingeschränkt.
Ausprobieren
Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem 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>> }'Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole
Details
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.
Parameter
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
boardId (path) | Uuid | Ja | Project board ID (UUIDv7). |
Anfragekörper
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
user_id | string | Nein | Somebody who already has an account. Give this **or** `email`, not both. |
email | string | Nein | Invite somebody who does not have an account yet. |
role | string<manager, member, client> | Ja | — |
member_org_id | string | Nein | Which organisation this seat belongs to. Ignored for a `client` seat, which is always the board's own client organisation. |
Antwort
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
id | Uuid | Ja | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
board_id | Uuid | Ja | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
user_id | Uuid | Ja | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
member_org_id | Uuid | Ja | The organisation this seat belongs to — the agency's, or the client's. |
role | string<manager, member, client> | Ja | — |
last_read_at | string | Nein | — |
created_at | string | Nein | — |
user | AgencyBoardActor | Nein | 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 | Nein | — |
Fehler, die dieser Endpunkt zurückgeben kann
401 · 403 · 404 · 422