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