Introduction
The Groups API provides functionality for managing groups, including creating, deleting, updating, and querying groups.
Settings for Typical Use Case
Site admins determine who can create a group. This setting can be found in your site's Dashboard under Groups Application > General Settings > Group Creation.
If set to site members with admin approval, site members can create a group using the createGroup()
function, and the group becomes a createRequest
with a name of PENDING
. The site admin either approves or rejects the request to create a group.
If set to all site members, site members can create a group using the createGroup()
function (no approval required).
If set to only admins, only site admins can create a group using the createGroup()
function.
The default is set to site members with admin approval.
When a group is created, the newly created group is added to the Groups List page of your site.
The Groups API provides functionality allowing you to:
- Create a new group.
- Delete an existing group.
- Get group information by ID.
- Get group information by slug.
- List all groups.
- Query groups.
- Update group information.