Introduction

 

Developer Preview
APIs in Developer Preview are subject to change and are not intended for use in production.
Send us your suggestions for improving this API. Your feedback is valuable to us.

 

Note: This module is universal. Functions in this module can run on both the backend and frontend, unless specified otherwise.

The Roles API provides functionality for managing roles of group members.

With the Roles API, you can:

  • Assign a role to specific group members.
  • Unassign a role from specific group members.

Note: This module is only relevant for site admins and group admins.

To use the Roles API, import { roles } from the wix-groups.v2 module.

Copy

Before you begin

Before you begin coding, make sure to add the Wix Groups application to your site.

Terminology

  • Site Admin: A site owner or site collaborator with admin permissions.
  • Group Member: A site member belonging to a group.
  • Group Admin: A group member that was assigned the 'group admin' role by either the site admin, or another group admin. The creator of a group is automatically a group admin. The group admin has the same permissions as a site admin, but only for the specified group.
Did this help?