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 Create Requests API provides functionality for managing requests to create a group.

With the Create Requests API, you can:

  • Approve requests to create a group.
  • List requests to create a group.
  • Query requests to create a group.
  • Reject requests to create a group.

Note: This module is only relevant if admin approval is required for creating a group.

To use the Create Requests API, import { createRequests } from the wix-groups.v2 module.

Copy
1

Before you begin

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

Settings for Typical Use Case

  • Site admins determine who can create groups. They can choose to require that site members request approval when creating a group.
  • This setting can be found in your site's Dashboard under Groups Application > General Settings > Group Creation.
  • If set to admin approval required, a site member uses the createGroup() function to create a group, and the group becomes a groupRequest with a status of PENDING.
  • Only a site admin can approve or reject requests to create a group.
  • When a site member's request to create a group is approved, the groupRequest status changes to APPROVED, and the newly created group is added to the Groups List page of your site.

Terminology

  • Group Request: A request made by a site member to create the group.
  • Site Admin: A site owner or site collaborator with admin permissions. Site admins determine who can create groups.
Was this helpful?
Yes
No