agency-board

POST `/v1/agency/boards/{boardId}/members`

Put somebody on a board, or invite them by email.

Ìfàṣẹ́pọ̀

Fi bọ́kì kọ́kọ́ (bearer token) ránṣẹ́ gẹ́gẹ́ bí àmì ìdánimọ̀ API. Ibùdó yìí kò sọ àṣẹ pàtó kan nínú àlàyé rẹ̀, nítorí náà fún kọ́kọ́ rẹ̀ ní ohun tó kéré jù lọ tí ó nílò kí o sì ṣàyẹ̀wò ìdáhùn náà dípò kí o kàn rò ó.

Ojú abánisọ̀rọ̀ yìí kò gba id ajọ kankan. Kọ́kọ́rọ́ rẹ ti mọ ajọ ti o jẹ ti e, a o si fèsì nipa rẹ̀.

Gbiyanju rẹ

Rọ́pọ̀ èyíkéyìí nínú àwọn àmì ìtọ́ka < > pẹ̀lú iye tirẹ̀, àti àmì ìdánimọ̀ bọ́tìnnì náà pẹ̀lú bọ́tìnnì kan láti inú dásibọ̀ọ̀dù rẹ.

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>> }'

Ṣé o ti wọlé? Iwọ̀n api ní nú ìgbékalẹ̀ rẹ kún id àjọ gidi rẹ ati bọtini tirẹ, o si nṣiṣẹ ibeere na lòdì si api gidi ki o le rii esi gidi na. Ṣí ojú abáná yìí sílẹ̀ nínú kọnsólù API

Àwọn kúlẹ̀kúlẹ̀

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.

Àwọn ìpìlẹ̀

Orúkọ	Iru	Tí a nílò	Kini o jẹ
`boardId (path)`	`Uuid`	Bẹẹni	Project board ID (UUIDv7).

Akoonu ibeere naa

Orúkọ	Iru	Tí a nílò	Kini o jẹ
`user_id`	`string`	Bẹẹkọ	Somebody who already has an account. Give this or `email`, not both.
`email`	`string`	Bẹẹkọ	Invite somebody who does not have an account yet.
`role`	`string<manager, member, client>`	Bẹẹni	—
`member_org_id`	`string`	Bẹẹkọ	Which organisation this seat belongs to. Ignored for a `client` seat, which is always the board's own client organisation.

Idahun

Orúkọ	Iru	Tí a nílò	Kini o jẹ
`id`	`Uuid`	Bẹẹni	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`board_id`	`Uuid`	Bẹẹni	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`user_id`	`Uuid`	Bẹẹni	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`member_org_id`	`Uuid`	Bẹẹni	The organisation this seat belongs to — the agency's, or the client's.
`role`	`string<manager, member, client>`	Bẹẹni	—
`last_read_at`	`string`	Bẹẹkọ	—
`created_at`	`string`	Bẹẹkọ	—
`user`	`AgencyBoardActor`	Bẹẹkọ	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`	Bẹẹkọ	—

Awọn aṣiṣe ti ibudo ipari yii le da pada

401 · 403 · 404 · 422

POST /v1/agency/boards/{boardId}/members