agency-board
POST /v1/agency/boards/{boardId}/members
Put somebody on a board, or invite them by email.
Autentikasi
Kirimkan kunci API sebagai token bearer. Titik akhir ini tidak menyatakan izin tertentu dalam spesifikasi, jadi berikan kunci Anda izin minimum yang diperlukan dan periksa responsnya alih-alih berasumsi.
Endpoint ini tidak memerlukan id organisasi. Kunci Anda telah mengidentifikasi organisasi tempatnya berafiliasi, dan respons akan dibatasi untuk organisasi tersebut.
Coba
Ganti apa pun di dalam tanda kurung sudut dengan nilai Anda sendiri, dan placeholder kunci dengan kunci dari dasbor Anda.
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>> }'Sudah masuk? Konsol API di dasbor Anda akan mengisi ID organisasi asli dan kunci Anda sendiri, serta menjalankan permintaan terhadap API langsung sehingga Anda dapat melihat respons aktualnya. Buka titik akhir ini di konsol API
Detail
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.
Parameter
| Nama | Jenis | Wajib | Tentang apa ini |
|---|---|---|---|
boardId (path) | Uuid | Ya | Project board ID (UUIDv7). |
Isi permintaan
| Nama | Jenis | Wajib | Tentang apa ini |
|---|---|---|---|
user_id | string | Tidak | Somebody who already has an account. Give this **or** `email`, not both. |
email | string | Tidak | Invite somebody who does not have an account yet. |
role | string<manager, member, client> | Ya | — |
member_org_id | string | Tidak | Which organisation this seat belongs to. Ignored for a `client` seat, which is always the board's own client organisation. |
Tanggapan
| Nama | Jenis | Wajib | Tentang apa ini |
|---|---|---|---|
id | Uuid | Ya | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
board_id | Uuid | Ya | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
user_id | Uuid | Ya | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
member_org_id | Uuid | Ya | The organisation this seat belongs to — the agency's, or the client's. |
role | string<manager, member, client> | Ya | — |
last_read_at | string | Tidak | — |
created_at | string | Tidak | — |
user | AgencyBoardActor | Tidak | 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 | Tidak | — |
Kesalahan yang dapat dikembalikan oleh titik akhir ini
401 · 403 · 404 · 422