Cloud APIs
GroupsApi
updateGroupMemberRole

updateGroupMemberRole

Updates the group membership for a particular group member. This action requires the requester to be able to manage lower ranked members. Guest or Owner ranks cannot be assigned, and a requester cannot change their own rank.

Parameters

NameTypeDescription
groupIdGroupIdThe id of the group to change a users role for.
userIdIdentifierThe id of the user to change role for.
roleIdRoleIdThe id of the role to update to.

Example

const { data: success } = await GroupsApi.updateGroupMemberRole({
  groupId: 5850082,
  userId: 2655994471,
  roleId: 41112469,
}); 

Example Data

{
  path: "groups/5850082/memberships/MTU5OTk0MDk4NQ",
  createTime: 2020-04-30T10:28:57.147Z,
  updateTime: "2025-05-17T16:26:10.879549500Z",
  user: "users/1599940985",
  role: "groups/5850082/roles/41112469",
} 

Endpoint

PATCH /v2/groups/{groupId}/memberships/{userId}