agency-board
POST /v1/agency/boards/{boardId}/members
Put somebody on a board, or invite them by email.
Autentizace
Odešlete klíč API jako bearer token. Tento koncový bod ve specifikaci uvádí specifické oprávnění, takže svému klíči udělte to nejmenší možné a místo předpokladů zkontrolujte odpověď.
Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.
Vyzvednout
Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.
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>> }'Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API
Podrobnosti
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.
Parametry
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
boardId (path) | Uuid | Ano | Project board ID (UUIDv7). |
Tělo požadavku
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
user_id | string | Ne | Somebody who already has an account. Give this or email, not both. |
email | string | Ne | Invite somebody who does not have an account yet. |
role | string<manager, member, client> | Ano | — |
member_org_id | string | Ne | Which organisation this seat belongs to. Ignored for a client seat, which is always the board's own client organisation. |
Odpověď
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
id | Uuid | Ano | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
board_id | Uuid | Ano | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
user_id | Uuid | Ano | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
member_org_id | Uuid | Ano | The organisation this seat belongs to — the agency's, or the client's. |
role | string<manager, member, client> | Ano | — |
last_read_at | string | Ne | — |
created_at | string | Ne | — |
user | AgencyBoardActor | Ne | 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 | Ne | — |
Chyby, které může tento koncový bod vrátit
401 · 403 · 404 · 422