agency-board

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

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

모든 agency-board 엔드포인트

인증

Bearer 토큰으로 API 키를 전송하세요. 이 엔드포인트는 명세에 특정 권한을 명시하지 않으므로, 가정하기보다는 키에 필요한 최소한의 권한을 부여하고 응답을 확인하세요.

이 엔드포인트는 조직 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)UuidProject board ID (UUIDv7).

요청 본문

이름유형필수설명
user_idstring아니요Somebody who already has an account. Give this **or** `email`, not both.
emailstring아니요Invite somebody who does not have an account yet.
rolestring<manager, member, client>
member_org_idstring아니요Which organisation this seat belongs to. Ignored for a `client` seat, which is always the board's own client organisation.

응답

이름유형필수설명
idUuidUUIDv7 identifier — sortable by creation time (docs/02 §8).
board_idUuidUUIDv7 identifier — sortable by creation time (docs/02 §8).
user_idUuidUUIDv7 identifier — sortable by creation time (docs/02 §8).
member_org_idUuidThe organisation this seat belongs to — the agency's, or the client's.
rolestring<manager, member, client>
last_read_atstring아니요
created_atstring아니요
userAgencyBoardActor아니요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_byAgencyBoardActor아니요

이 엔드포인트가 반환할 수 있는 오류

401 · 403 · 404 · 422