agency-board

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

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

Svi agency-board krajnji točke

Sva developerska dokumentacija

Autentifikacija

Pošaljite API ključ kao bearer token. Ova krajnja točka ne navodi određenu dozvolu u specifikaciji, stoga dajte svom ključu najmanje što mu je potrebno i provjerite odgovor umjesto da pretpostavljate.

Ova krajnja točka ne prihvaća ID organizacije. Vaš ključ već identificira organizaciju kojoj pripada, a odgovor je ograničen na nju.

Isprobajte

Zamijenite sve unutar šiljastih zagrada svojim vlastitim vrijednostima, a rezervirano mjesto za ključ s ključem iz vaše nadzorne ploče.

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

Prijavljeni ste? API konzola na vašoj nadzornoj ploči automatski unosi stvarni ID vaše organizacije i vaš vlastiti ključ te šalje zahtjev prema aktivnom API-ju kako biste mogli vidjeti stvarni odgovor. Otvori ovu krajnju točku u API konzoli

Pojedinosti

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.

Parametri

NazivVrstaObaveznoŠto je to
boardId (path)UuidDaProject board ID (UUIDv7).

Tijelo zahtjeva

NazivVrstaObaveznoŠto je to
user_idstringNeSomebody who already has an account. Give this or email, not both.
emailstringNeInvite somebody who does not have an account yet.
rolestring<manager, member, client>Da
member_org_idstringNeWhich organisation this seat belongs to. Ignored for a client seat, which is always the board's own client organisation.

Odgovor

NazivVrstaObaveznoŠto je to
idUuidDaUUIDv7 identifier — sortable by creation time (docs/02 §8).
board_idUuidDaUUIDv7 identifier — sortable by creation time (docs/02 §8).
user_idUuidDaUUIDv7 identifier — sortable by creation time (docs/02 §8).
member_org_idUuidDaThe organisation this seat belongs to — the agency's, or the client's.
rolestring<manager, member, client>Da
last_read_atstringNe
created_atstringNe
userAgencyBoardActorNeWho 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_byAgencyBoardActorNe

Pogreške koje ova krajnja točka može vratiti

401 · 403 · 404 · 422