agency-board

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

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

प्रमाणीकरण

एपिआई कुञ्जीलाई बियरर टोकन (bearer token) को रूपमा पठाउनुहोस्। यो इन्डपोइन्टले विशिष्ट अनुमति खुलाएको छैन, त्यसैले अनुमान गर्नुको सट्टा आफ्नो कुञ्जीलाई आवश्यक पर्ने न्यूनतम अधिकार दिनुहोस् र प्रतिक्रिया जाँच गर्नुहोस्।

यो इन्डपोइन्टले कुनै संस्थाको आइडी लिँदैन। तपाईंको कुञ्जीले यस अन्तर्गत पर्ने संस्थालाई पहिल्यै पहिचान गर्छ, र प्रतिक्रिया त्यसैमा सीमित हुन्छ।

प्रयास गर्नुहोस्

कोणीय कोष्ठकभित्र भएका जुनसुकै कुरालाई आफ्नो मानहरूद्वारा बदल्नुहोस्, र मुख्य स्थानहोल्डरलाई तपाईंको ड्यासबोर्डको कुञ्जीद्वारा बदल्नुहोस्।

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_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

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