create_groups

Admin-only MCP tool.

Create one or more groups.

Groups are what permissions are given to; users can belong to one or more groups. All users with accounts are members of the Registered Users group (group 2). Before creating a group, check with list_groups whether something suitable already exists. Do not create new groups when the existing ones would meet the need.

Creating a group gives it no permissions and no members. Use set_form_permissions to say what it can do, and update_group_members to put people in it.

Some groups come from the entries in a form (form-based entry groups). Such groups are not created here, they appear automatically when entries are created in a form that has the entries-are-groups setting, and they are named after the entry. Even if a system is using form-based entry groups, there may still be a need to manually create groups for other purposes, such as an “All Outfielders” group in a system with form-based entry groups for each baseball team. Or a “Registration Approvers” group if approving registrations is a special permission that only a few users have, independent of the rest of the group membership structure.

Properties

Property Type Required? Description
groups array of object Required

Required. The groups to create.

← Back to the MCP reference