agency-board

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

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

تصدیق‌هویت

د بیارر ټوکن په توګه یو API کي وسپارئ. دا پای ټکی په مشخصاتو کې کوم ځانګړی اجازه لیک نه بیانوي، نو خپل کیلي ته لږترلږه هغه څه ورکړئ چې ورته اړتیا لري او د فرض کولو پر ځای ځواب وپلټئ.

دا پای نقطه د سازمان هېڅ آی ډي نه اخلي. ستاسو کیلي مخکې تر مخکې هغه سازمان په ګوته کوي چې پورې اړه لري، او ځواب ورته محدود دی.

هڅه وکړئ

د انګلیسي په زاوي پنسونو کې هرڅه د خپلو ارزښتونو سره بدل کړئ، او د کلي ځای لرونکی ستاسو د ډشبورډ د کلي سره.

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 کنسول ستاسو د اصلي سازمان ID او ستاسو خپله کیلي ډکوي، او غوښتنه د ژوندی API په وړاندې پرمخ وړي ترڅو تاسو وکولی شئ اصلي ځواب وګورئ. دا پای ټکی (endpoint) د 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

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