agency-board

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

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

Նույնականացում

Ուղարկեք API բանալին որպես bearer թոքեն։ Այս վերջնակետը բնութագրում չի նշում որոշակի թույլտվության մասին, ուստի տվեք ձեր բանալուն նվազագույն անհրաժեշտը և ենթադրություններ անելու փոխարեն ստուգեք պատասխանը:

Այս վերջնակետը կազմակերպության ID չի ընդունում: Ձեր բանալին արդեն իսկ նույնականացնում է այն կազմակերպությունը, որին պատկանում է, և պատասխանը սահմանափակված է դրանով:

Փորձել

Փոխարինեք անկյունային փակագծերում գտնվող ցանկացած բան ձեր սեփական արժեքներով, և բանալու տեղապահը՝ ձեր վահանակի բանալիով:

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-ի դեմ, որպեսզի կարողանաք տեսնել փաստացի պատասխանը: Բացեք այս վերջնակետը 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