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 to true.

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 createRequest with a status of PENDING.
  • Only a site admin can approve or reject requests to create a group.
  • Note: If the suppressAuth option is set to true, 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 to APPROVED, and the newly created group is added to the Groups List page of your site.

The CreateRequests API provides functionality allowing you to:

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

Permissions Information

Note: You can override the permissions below by setting the suppressAuth option to true.

FunctionsPermissions
approveCreateRequests(), listCreateRequests(),
queryCreateRequests(), rejectCreateRequests()		Site admin

To use the CreateRequests API, import createRequests from the wix-groups-backend module:

Copy
Did this help?