Introduction
The Members API provides functionality for managing group members, inluding adding, removing, and querying group members.
Settings for Typical Use Case
- If a group's privacy level is set to
SECRET
, group admins or group members can add additional members to their group. - If a group's privacy level is set to
PUBLIC
orPRIVATE
, group admins determine whether group members can add additional members to their group. - This setting can be found in your site's Dashboard under Groups Application > Your Group > Admin Tools > Member Permissions.
- If set to all members, group members can add additional members to the group using the
addGroupMembers()
function (no approval required). - If set to admins only, only admins can add additional members to the group using the
addGroupMembers()
function. - The default is set to admins only.
- Note: If the
suppressAuth
option is set totrue
, all permissions are overwritten and all site members (including non-group members) can add additional members to a group.
The Members API provides functionality allowing you to:
Permissions Information
Note: You can override the permissions below by setting the
suppressAuth
option totrue
.
Functions | Permissions |
---|---|
addGroupMembers() | Manage in your site's Dashboard |
removeGroupMembers() | Site admin, group admin |
listGroupMembers() , listMemberships() , queryGroupMembers() , queryMemberships() | For public & private groups: any site member For secret groups: group members, site admin, group admin |
javascript | Copy Codeimport { members } from "wix-groups-backend";
Was this helpful?