agency-board

POST `/v1/agency/boards/{boardId}/members`

Put somebody on a board, or invite them by email.

Uwierzytelnianie

Wyślij klucz API jako token bearer. Ten punkt końcowy nie określa konkretnego uprawnienia w specyfikacji, więc nadaj swojemu kluczowi minimum potrzebnych uprawnień i sprawdź odpowiedź zamiast zakładać.

Ten punkt końcowy nie wymaga identyfikatora organizacji. Twój klucz już identyfikuje organizację, do której należy, a odpowiedź jest do niej ograniczona.

Wypróbuj

Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.

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>> }'

Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API

Szczegóły

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

Nazwa	Typ	Wymagane	Co to jest
`boardId (path)`	`Uuid`	Tak	Project board ID (UUIDv7).

Treść żądania

Nazwa	Typ	Wymagane	Co to jest
`user_id`	`string`	Nie	Somebody who already has an account. Give this or `email`, not both.
`email`	`string`	Nie	Invite somebody who does not have an account yet.
`role`	`string<manager, member, client>`	Tak	—
`member_org_id`	`string`	Nie	Which organisation this seat belongs to. Ignored for a `client` seat, which is always the board's own client organisation.

Odpowiedź

Nazwa	Typ	Wymagane	Co to jest
`id`	`Uuid`	Tak	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`board_id`	`Uuid`	Tak	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`user_id`	`Uuid`	Tak	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`member_org_id`	`Uuid`	Tak	The organisation this seat belongs to — the agency's, or the client's.
`role`	`string<manager, member, client>`	Tak	—
`last_read_at`	`string`	Nie	—
`created_at`	`string`	Nie	—
`user`	`AgencyBoardActor`	Nie	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`	Nie	—

Błędy, które ten punkt końcowy może zwrócić

401 · 403 · 404 · 422

POST /v1/agency/boards/{boardId}/members