agency-board
POST /v1/agency/boards/{boardId}/members
Put somebody on a board, or invite them by email.
प्रमाणीकरण
बेअरर टोकन म्हणून API की पाठवा. या एंडपॉईंटने स्पष्टीकरणामध्ये ठराविक परवानगी नमूद केलेली नाही, त्यामुळे तुमच्या कीला आवश्यक तेवढाच कमीत कमी ॲक्सेस द्या आणि गृहीत धरण्याऐवजी प्रतिसाद तपासा.
या एंडपॉइंटला कोणतीही संस्था आयडी (organisation id) लागत नाही. तुमची की (key) आधीच ती कोणत्या संस्थेशी संबंधित आहे हे ओळखते आणि प्रतिसाद त्यानुसार मर्यादित केला जातो.
प्रयत्न करा
कोनसांस्कृतिक कंसात (<>) असलेली कोणतीही गोष्ट तुमच्या स्वतःच्या मूल्यांनी बदला आणि key प्लेसहोल्डरला तुमच्या डॅशबोर्डवरील किने बदला.
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 विरुद्ध विनंती कार्यान्वित करतो जेणेकरून तुम्हाला वास्तविक प्रतिसाद पाहता येईल. एपी कन्सोलमध्ये हा एंडपॉइंट उघडा
तपशील
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