access

PATCH `/v1/orgs/{orgId}/members/{userId}`

Change a member's role.

प्रमाणीकरण

बेरर टोकन म्हणून API की पाठवा. की मध्ये members.role.assign परवानगी असणे आवश्यक आहे; ती नसलेली की 404 ऐवजी 403 सह नाकारली जाते.

जिथे तुमचा ऑर्गनायझेशन आयडी (organization id) जाईल

हा एन्डकॉप्ट तुमच्या संस्थेची आयडी थेट URL मध्ये orgId म्हणून घेतो. तो पाथमध्ये टाका — त्यासाठी दुसरा कोणताही हेडर किंवा क्वेरी पॅरामीटर चालणार नाही.

तुमची संस्था आयडी (organisation id) तुमच्या डॅशबोर्डवरील API की स्क्रीनवर, की च्या बाजूला आहे. तुम्ही केलेल्या प्रत्येक कॉलमधील तोच आयडी असतो.

प्रयत्न करा

कोनसांस्कृतिक कंसात (<>) असलेली कोणतीही गोष्ट तुमच्या स्वतःच्या मूल्यांनी बदला आणि key प्लेसहोल्डरला तुमच्या डॅशबोर्डवरील किने बदला.

curl -X PATCH https://api.zinndigital.com/v1/orgs/{orgId}/members/{userId} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "role": <string> }'

साइन इन केलेले आहे? तुमच्या डॅशबोर्डमधील API कन्सोल तुमची खरी संस्था आयडी आणि तुमची स्वतःची की आपोआप भरतो आणि लाइव्ह API विरुद्ध विनंती कार्यान्वित करतो जेणेकरून तुम्हाला वास्तविक प्रतिसाद पाहता येईल. एपी कन्सोलमध्ये हा एंडपॉइंट उघडा

तपशील

Sets this member's role in the organization. Requires members.role.assign on that org. ⛔ Replaces the member's roles with the one given rather than adding to them — a person may hold several Membership rows, and collapsing them can only ever reduce what they hold, so no path through this endpoint escalates by accident. Three refusals, and they are the same rules an invitation is held to: 403 if the member holds a permission the caller does not (more_privileged), 403 if the role being granted holds one (role_not_grantable — this is what stops any holder of the key promoting themselves to owner), and 409 for the org's last owner (last_owner). An unknown role is a 422, never a 403, so a typo is distinguishable from a permission you lack.

पॅरामीटर्स

नाव	प्रकार	आवश्यक	हे काय आहे
`orgId (path)`	`Uuid`	होय	Organization ID (UUIDv7).
`userId (path)`	`Uuid`	होय	The user to remove from the organization.

विनंती मुख्य भाग

नाव	प्रकार	आवश्यक	हे काय आहे
`role`	`string`	होय	A role key from `GET /v1/orgs/{orgId}/roles`.

प्रतिसाद

नाव	प्रकार	आवश्यक	हे काय आहे
`user_id`	`Uuid`	होय	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`email`	`string`	होय	—
`name`	`string`	होय	Display name; may be empty for an account that never set one.
`roles`	`string[]`	होय	Every role this person holds in this org, sorted.
`joined_at`	`string`	होय	When their EARLIEST membership of this org was created.
`is_self`	`boolean`	होय	Whether this row is the calling user.
`removable`	`boolean`	होय	—
`not_removable_reason`	`OrgMemberRemovalBlock \| null`	होय	Why not, when `removable` is false. Null when removable — and also null for a caller lacking `members.remove`, because "you cannot remove anyone here" is a fact about the caller,…
`role_assignable`	`boolean`	होय	Whether `PATCH` on this member would be accepted — the caller holds `members.role.assign` here, does not outrank themselves, and this is not the last owner. ⛔ Which role may…

ही एंडपॉइंट परत करू शकेल अशा त्रुटी

401 · 403 · 404 · 409 · 422 · 429

PATCH /v1/orgs/{orgId}/members/{userId}