Change a member's role or account status
Change a member's workspace role, their account status, or both.
/v1/workspace/members/{user_id}Admin- Operation id
- patch_member
- Access
- An editor or a viewer is refused.
/v1/workspace/members/{user_id}Change a member's workspace role, their account status, or both.
Send at least one of role and status. An empty body is refused.
You cannot grant a role above your own. An admin cannot make someone an owner, and the attempt is refused rather than partly applied.
Role changes take effect on the member's next request. There is nothing cached and no session to wait out, so a demotion is immediate. Suspending someone stops them using the workspace at all while keeping their membership and their role.
The last owner cannot be demoted, so a workspace can never be left with nobody who can administer it.
Tenancy: the request is scoped to one workspace, and the credential presented is what selects it. A caller with no membership in that workspace is refused with 404, which is indistinguishable from a workspace that does not exist.
Authorisation: admin or owner. An editor or viewer receives 403 insufficient_role.
Access: Authorization: Bearer carrying either a realm access token or an API key. A key must hold the workspace-admin:write scope, and the workspace role of the person who owns it must meet the floor above.
A realm-issued access token, presented as Authorization: Bearer <token>. It acts as the person who signed in, and every operation resolves their workspace role live from the membership record.
In: header
Path Parameters
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
curl -X PATCH "https://example.com/v1/workspace/members/497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "Content-Type: application/json" \ -d '{}'{}