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, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі 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 | Ні | — |
Помилки, які може повертати ця кінцева точка
401 · 403 · 404 · 422