agency-board

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

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

Kimlik Doğrulama

Bir API anahtarını bearer token olarak gönderin. Bu uç nokta, teknik özelliklerde belirli bir yetki belirtmemektedir; bu nedenle, varsaymak yerine anahtarınıza ihtiyaç duyduğu en az yetkiyi verin ve yanıtı kontrol edin.

Bu uç nokta hiçbir organizasyon kimliği almaz. Anahtarınız zaten ait olduğu organizasyonu tanımlar ve yanıt bu organizasyonla sınırlandırılır.

Dene

Köşeli parantez içindeki her şeyi kendi değerlerinizle ve anahtar yer tutucusunu panonuzdan bir anahtarla değiştirin.

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

Oturum açtınız mı? Panonuzdaki API konsolu, gerçek organizasyon kimliğinizi ve kendi anahtarınızı otomatik olarak doldurur ve isteği canlı API üzerinde çalıştırarak gerçek yanıtı görmenizi sağlar. Bu uç noktayı API konsolunda açın

Ayrıntılar

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.

Parametreler

Ad	Tür	Zorunlu	Ne olduğu
`boardId (path)`	`Uuid`	Evet	Project board ID (UUIDv7).

İstek gövdesi

Ad	Tür	Zorunlu	Ne olduğu
`user_id`	`string`	Hayır	Somebody who already has an account. Give this or `email`, not both.
`email`	`string`	Hayır	Invite somebody who does not have an account yet.
`role`	`string<manager, member, client>`	Evet	—
`member_org_id`	`string`	Hayır	Which organisation this seat belongs to. Ignored for a `client` seat, which is always the board's own client organisation.

Yanıt

Ad	Tür	Zorunlu	Ne olduğu
`id`	`Uuid`	Evet	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`board_id`	`Uuid`	Evet	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`user_id`	`Uuid`	Evet	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`member_org_id`	`Uuid`	Evet	The organisation this seat belongs to — the agency's, or the client's.
`role`	`string<manager, member, client>`	Evet	—
`last_read_at`	`string`	Hayır	—
`created_at`	`string`	Hayır	—
`user`	`AgencyBoardActor`	Hayır	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`	Hayır	—

Bu uç noktanın dönderebileceği hatalar

401 · 403 · 404 · 422

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