agency-board

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

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

Uthibitishaji

Tuma ufunguo wa API kama tokeni ya kubeba. Sehemu hii ya mwisho haitaji ruhusa maalum katika maelezo, kwa hivyo ipe ufunguo wako kiwango cha chini kabisa kinachohitajika na uangalie jibu badala ya kukisia.

Endpoint hii haichukui kitambulisho cha shirika. Ufunguo wako tayari unalitambua shirika linalohusika, na jibu limewekewa kikomo kwa shirika hilo pekee.

Jaribu

Badilisha chochote kilicho ndani ya mabano ya pembe na maadili yako mwenyewe, na kishikiliaji cha ufunguo na ufunguo kutoka kwa dashibodi yako.

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

Umeingia kwenye akaunti? Dashibodi yako ya kiweko cha API inajaza kitambulisho chako halisi cha shirika na ufunguo wako mwenyewe, na kuendesha ombi dhidi ya API ya moja kwa moja ili uweze kuona jibu halisi. Fungua sehemu hii ya mwisho (endpoint) kwenye konsole ya API

Maelezo

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.

Vigezo

Jina	Aina	Inayohitajika	Kilicho hiki
`boardId (path)`	`Uuid`	Ndiyo	Project board ID (UUIDv7).

Mwili wa ombi

Jina	Aina	Inayohitajika	Kilicho hiki
`user_id`	`string`	Hapana	Somebody who already has an account. Give this or `email`, not both.
`email`	`string`	Hapana	Invite somebody who does not have an account yet.
`role`	`string<manager, member, client>`	Ndiyo	—
`member_org_id`	`string`	Hapana	Which organisation this seat belongs to. Ignored for a `client` seat, which is always the board's own client organisation.

Majibu

Jina	Aina	Inayohitajika	Kilicho hiki
`id`	`Uuid`	Ndiyo	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`board_id`	`Uuid`	Ndiyo	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`user_id`	`Uuid`	Ndiyo	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`member_org_id`	`Uuid`	Ndiyo	The organisation this seat belongs to — the agency's, or the client's.
`role`	`string<manager, member, client>`	Ndiyo	—
`last_read_at`	`string`	Hapana	—
`created_at`	`string`	Hapana	—
`user`	`AgencyBoardActor`	Hapana	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`	Hapana	—

Hitilafu ambazo mwisho huu unaweza kurudisha

401 · 403 · 404 · 422

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