access

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

Change a member's role.

Автентифікація

Надішліть ключ API як маркер носія (bearer token). Ключ повинен мати дозвіл members.role.assign; ключ без нього відхиляється з кодом 403, а не 404.

Де вказується ідентифікатор вашої організації

Ця кінцева точка приймає ідентифікатор вашої організації безпосередньо в URL як orgId. Підставте його в шлях — немає заголовка чи параметра запиту, які б замінили це.

Ідентифікатор вашої організації знаходиться на екрані API-ключів у вашій панелі керування, поруч із самим ключем. Це той самий ідентифікатор у кожному вашому запиті.

Спробувати

Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.

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}