removeGroupMembers( )


Removes members from a group.

The removeGroupMembers() function returns a Promise that resolves when the member is removed from the group.

Note: Only site admins and group admins can remove members from their group.

Admin Method

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Method Declaration
Copy
Method Parameters
groupIdstringRequired

Group ID.


memberIdsArray<string>Required

IDs of the site members to remove from the group.

Was this helpful?
Yes
No