Go Headless

Build Apps

Client

API Preview

Develop Websites

REST

Velo

GraphQL (Alpha)

groupId

string

memberIds

role

GroupRole

options

AssignRoleOptions

Assigns a specific role to group members.


>**Note:** This function is only relevant for site admins, and group members with group admin permissions.

The `assignRole()` function returns a Promise that resolves to the newly-assigned role after it has successfully been assigned. Assigning a role overrides an existing role. For example, assigning a member role to an admin unassigned their admin role.

import { roles } from "wix-groups.v2";

// Sample ID values:
//   memberIds: ['7fe8e9e1-d050-4c86-9684-e7f231600a34'],
//   groupId: '0261a737-2361-4468-a3b1-5ec2b0667836.'
//
// Sample role value:
//   role: 'ADMIN'
//


export function assignRole(groupId, memberIds, role) {
  return roles.assignRole(groupId, memberIds, role)
    .then((response) => {
      console.log(response);
    })
    .catch((error) => {
      console.error(error);
    });
}

/* Promise resolves to:
 * role: "ADMIN"
 */

Assign a role to a group member (dashboard page code)

import { Permissions, webMethod } from 'wix-web-module';
import { roles } from 'wix-groups.v2';

// Sample ID values:
//   memberIds: ['7fe8e9e1-d050-4c86-9684-e7f231600a34'],
//   groupId: '0261a737-2361-4468-a3b1-5ec2b0667836.'
//
// Sample role value:
//   role: 'ADMIN'
//

export const assignRole = webMethod(Permissions.Anyone, (groupId, memberIds, role) => {
  return roles.assignRole(groupId, memberIds, role)
    .then((response) => {
      console.log(response);
    })
    .catch((error) => {
      console.error(error);
    });
});

/* Promise resolves to:
 * role: "ADMIN"
 */


Assign a role to a group member (export from backend code)

assignRole

AssignRoleResponse

UnassignRoleOptions

Unassigns a role from group members.

>**Note:** This function is only relevant for site admins, and group members with group admin permissions.

The `unassignRole()` function returns a Promise that resolves to the unassigned role after it has successfully been unassigned. This function only applies to admin roles. Using this function with member roles returns an error.

import { roles } from "wix-groups.v2";

// Sample ID values:
//   memberIds: ['7fe8e9e1-d050-4c86-9684-e7f231600a34'],
//   groupId: '0261a737-2361-4468-a3b1-5ec2b0667836.'
//
// Sample role value:
//   role: 'MEMBER'
//

export function unassignRole(groupId, memberIds, role) {
  return roles.unassignRole(groupId, memberIds, role)
    .then((response) => {
      console.log(response);
    })
    .catch((error) => {
      console.error(error);
    });
}

/* Promise resolves to:
 * role: "MEMBER"
 */

Unassign a role to a group member (dashboard page code)

import { Permissions, webMethod } from "wix-web-module";
import { roles } from "wix-groups.v2";

// Sample ID values:
//   memberIds: ['7fe8e9e1-d050-4c86-9684-e7f231600a34'],
//   groupId: '0261a737-2361-4468-a3b1-5ec2b0667836.'
//
// Sample role value:
//   role: 'MEMBER'
//

export const unassignRole = webMethod(Permissions.Anyone, async (groupId, memberIds, role) => {
  try {
    const response = await roles.unassignRole(groupId, memberIds, role);
    console.log(response);
  } catch (error) {
    console.error(error);
  }
});

/* Promise resolves to:
 * role: "MEMBER"
 */

Unassign a role to a group member (export from backend code)

unassignRole

UnassignRoleResponse

---
title: Introduction
---

# Introduction

&nbsp;
<div style="background-color: #FEF1D1; padding: 18px 24px; border-radius: 6px; border: 1px solid #FDB10C; box-sizing: border-box; display: inline-block">
    <b>Developer Preview</b>
    <br/>
    <span>APIs in <a href="https://www.wix.com/velo/reference/api-overview/developer-preview">Developer Preview</a> are subject to change and are not intended for use in production.<br/><a href="mailto:velo-preview-feedback@wix.com">Send us</a> your suggestions for improving this API. Your feedback is valuable to us.</span>
</div>  

&nbsp;

> **Note:** This module is
> [universal](/api-overview/api-versions#universal-modules).
> 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](https://www.wix.com/velo/reference/wix-members-v2). 
 
With the Roles API, you can:
- [Assign](/roles/assign-role) a role to specific group members.
- [Unassign](/roles/unassign-role) 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. 

```javascript
import { roles } from 'wix-groups.v2';
```

## Before you begin
Before you begin coding, make sure to add the [Wix Groups](https://support.wix.com/en/article/wix-groups-adding-and-setting-up-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.


velo-deps_wix-groups.v2_roles

Member's role.
- `MEMBER` - Regular group member.
- `ADMIN` - Group administrator.

assignRole( )