Introduction
The CreateRequests API provides functionality for managing requests to create a group.
Note: This module is only relevant if admin approval is required for creating a group, or if a function's
suppressAuth
option is set totrue
.
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 acreateRequest
with a status ofPENDING
. - Only a site admin can approve or reject requests to create a group.
- Note: If the
suppressAuth
option is set totrue
, all permissions are overwritten, and all site members can approve or reject requests to create a group. - When a site member's request to create a group is approved, the
createRequest
status changes toAPPROVED
, and the newly created group is added to the Groups List page of your site.
The CreateRequests API provides functionality allowing you to:
Permissions Information
Note: You can override the permissions below by setting the
suppressAuth
option totrue
.
Functions | Permissions |
---|---|
approveCreateRequests() , listCreateRequests() , queryCreateRequests() , rejectCreateRequests() | Site admin |
To use the CreateRequests API, import createRequests
from the wix-groups-backend
module:
javascript | Copy Codeimport { createRequests } from "wix-groups-backend";
Was this helpful?