Migration Rest Portal

Build Apps

Go Headless

Client

API Preview

Develop Websites

REST

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

To use the Roles API, install the `@wix/groups` package using npm or Yarn:
  ```console
npm install @wix/groups
```

or

```console
yarn add @wix/groups
```

Then import `{ roles }` from `@wix/groups`:

```js
import { roles } from '@wix/groups'
```
  

groups_roles

siteMemberIds

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

Setup