agency-board
POST /v1/agency/boards/{boardId}/members
Put somebody on a board, or invite them by email.
Autentifikatsiya
API kalitini bearer token sifatida yuboring. Ushbu yakuniy nuqta spetsifikatsiyada ma'lum bir ruxsatni ko'rsatmaydi, shuning uchun kalitingizga eng kam kerakli huquqni bering va taxmin qilish o'rniga javobni tekshiring.
Bu yakuniy nuqta hech qanday tashkilot identifikatorini qabul qilmaydi. Sizning kalitingiz unga tegishli tashkilotni allaqachon aniqlaydi va javob shunga qarab cheklanadi.
Sinab ko'rish
Qavslardagi har qanday narsani o'z qiymatlaringiz bilan, kalit pleysxolderini эsa boshqaruv panelingizdagi kalit bilan almashtiring.
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>> }'Tizimga kirganmisiz? Boshqaruv panelingizdagi API konsoli haqiqiy tashkilot ID raqamingiz va shaxsiy kalitingizni avtomatik to'ldiradi hamda haqiqiy javobni ko'rishingiz uchun so'rovni jonli API orqali bajaradi. Ushbu yakuniy nuqtani API konsolida oching
Tafsilotlar
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.
Parametrlar
| Nomi | Turi | Majburiy | Nima bu |
|---|---|---|---|
boardId (path) | Uuid | Ha | Project board ID (UUIDv7). |
Soʻrov tanasi
| Nomi | Turi | Majburiy | Nima bu |
|---|---|---|---|
user_id | string | Yo'q | Somebody who already has an account. Give this **or** `email`, not both. |
email | string | Yo'q | Invite somebody who does not have an account yet. |
role | string<manager, member, client> | Ha | — |
member_org_id | string | Yo'q | Which organisation this seat belongs to. Ignored for a `client` seat, which is always the board's own client organisation. |
Javob
| Nomi | Turi | Majburiy | Nima bu |
|---|---|---|---|
id | Uuid | Ha | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
board_id | Uuid | Ha | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
user_id | Uuid | Ha | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
member_org_id | Uuid | Ha | The organisation this seat belongs to — the agency's, or the client's. |
role | string<manager, member, client> | Ha | — |
last_read_at | string | Yo'q | — |
created_at | string | Yo'q | — |
user | AgencyBoardActor | Yo'q | 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 | Yo'q | — |
Ushbu yakuniy nuqta qaytarishi mumkin bo'lgan xatolar
401 · 403 · 404 · 422