access

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

Change a member's role.

प्रमाणन

बेरर टोकन के रूप में एक API कुंजी भेजें। कुंजी के पास members.role.assign अनुमति होनी चाहिए; इसके बिना एक कुंजी को 404 के बजाय 403 के साथ अस्वीकार कर दिया जाता है।

जहां आपकी संगठन आईडी आती है

यह एंडपॉइंट URL में ही आपके संगठन की आईडी को orgId के रूप में लेता है। इसे पाथ में बदलें — इसके विकल्प के रूप में काम करने वाला कोई हेडर या क्वेरी पैरामीटर नहीं है।

आपकी ऑर्गनाइजेशन आईडी आपके डैशबोर्ड पर एपीआई कीज़ स्क्रीन पर, की के ठीक बगल में मौजूद है। यह आपके द्वारा की जाने वाली हर कॉल में समान आईडी होती है।

इसे आज़माएँ

कोणार्कित ब्रैकेट्स में दी गई किसी भी चीज़ को अपने मानों से बदलें, और की प्लेसहोलर को अपने डैशबोर्ड की एक की से बदलें।

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 के विरुद्ध अनुरोध चलाता है ताकि आप वास्तविक प्रतिक्रिया देख सकें। इस एंडपॉइंट को 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}