agency-board
POST /v1/agency/boards/{boardId}/members
Put somebody on a board, or invite them by email.
Упълномощаване
Изпратете API ключ като носител (bearer token). Тази точка за достъп не указва конкретно разрешение в спецификацията, затова дайте на ключа си най-малкото необходимо и проверете отговора, вместо да правите предположения.
Този ендпойнт не изисква идентификатор на организация. Вашият ключ вече идентифицира организацията, към която принадлежи, и отговорът е ограничен до нея.
Опитайте
Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.
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>> }'Влязохте ли в профила си? API конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в API конзолата
Детайли
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.
Параметри
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
boardId (path) | Uuid | Да | Project board ID (UUIDv7). |
Тяло на заявката
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
user_id | string | Не | Somebody who already has an account. Give this **or** `email`, not both. |
email | string | Не | Invite somebody who does not have an account yet. |
role | string<manager, member, client> | Да | — |
member_org_id | string | Не | Which organisation this seat belongs to. Ignored for a `client` seat, which is always the board's own client organisation. |
Отговор
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
id | Uuid | Да | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
board_id | Uuid | Да | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
user_id | Uuid | Да | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
member_org_id | Uuid | Да | The organisation this seat belongs to — the agency's, or the client's. |
role | string<manager, member, client> | Да | — |
last_read_at | string | Не | — |
created_at | string | Не | — |
user | AgencyBoardActor | Не | 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 | Не | — |
Грешки, които този крайpoint може да върне
401 · 403 · 404 · 422