agency-board
POST /v1/agency/boards/{boardId}/members
Put somebody on a board, or invite them by email.
Autenticazione
Invia una chiave API come bearer token. Questo endpoint non specifica un permesso specifico nella specifica, quindi assegna alla tua chiave i permessi minimi necessari e verifica la risposta invece di fare supposizioni.
Questo endpoint non richiede alcun ID organizzazione. La tua chiave identifica già l'organizzazione a cui appartiene e la risposta è limitata ad essa.
Provalo
Sostituisci qualsiasi elemento tra parentesi angolari con i tuoi valori e il segnaposto key con una chiave dalla tua 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>> }'Hai effettuato l'accesso? La console API nella tua dashboard inserisce il tuo ID organizzazione reale e la tua chiave personale, ed esegue la richiesta sull'API live in modo da poter vedere la risposta effettiva. Apri questo endpoint nella console API
Dettagli
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.
Parametri
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
boardId (path) | Uuid | Sì | Project board ID (UUIDv7). |
Corpo della richiesta
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
user_id | string | No | Somebody who already has an account. Give this **or** `email`, not both. |
email | string | No | Invite somebody who does not have an account yet. |
role | string<manager, member, client> | Sì | — |
member_org_id | string | No | Which organisation this seat belongs to. Ignored for a `client` seat, which is always the board's own client organisation. |
Risposta
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
id | Uuid | Sì | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
board_id | Uuid | Sì | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
user_id | Uuid | Sì | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
member_org_id | Uuid | Sì | The organisation this seat belongs to — the agency's, or the client's. |
role | string<manager, member, client> | Sì | — |
last_read_at | string | No | — |
created_at | string | No | — |
user | AgencyBoardActor | No | 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 | No | — |
Errori che questo endpoint può restituire
401 · 403 · 404 · 422