agency-board

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

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

બધા agency-board એન્ડપૉઇન્ટ્સ

બધા ડેવલપર દસ્તાવેજો

પ્રમાણીકરણ

બિયરર ટૉકન તરીકે API કી મોકલો. આ એન્ડપૉઇન્ટ સ્પેશિફિકેશનમાં કોઈ ચોક્કસ પરવાનગી જણાવતું નથી, તેથી ધારણા બાંધવાને બદલે તમારી કીને તેની જરૂરિયાત મુજબ ન્યૂનતમ પરવાનગી આપો અને રિસ્પોન્સ તપાસો.

આ એન્ડપૉઇન્ટ કોઈ સંસ્થા આઈડી (organisation id) લેતું નથી. તમારી કી (key) પહેલેથી જ તે જે સંસ્થા સાથે સંબંધિત છે તેની ઓળખ કરે છે, અને પ્રતિસાદ (response) તે જ પૂરતો મર્યાદિત છે.

આયમાવો

કોઈપણ કૌંસમાં રહેલી બાબતને તમારા પોતાના મૂલ્યોથી બદલો અને કી પ્લેસહોલ્ડરને તમારા ડેશબોર્ડની કીથી બદલો.

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 કન્સોલ તમારી વાસ્તવિક સંસ્થાની આઈડી અને તમારી પોતાની કી ભરે છે, અને લાઇવ 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_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.

જવાબ

નામપ્રકારજરૂરીતે શું છે
idUuidહાUUIDv7 identifier — sortable by creation time (docs/02 §8).
board_idUuidહાUUIDv7 identifier — sortable by creation time (docs/02 §8).
user_idUuidહાUUIDv7 identifier — sortable by creation time (docs/02 §8).
member_org_idUuidહાThe 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