update_groups

Admin-only MCP tool.

Change the name or description of one or more groups. Only the properties you supply are changed.

Renaming a group does not affect its permissions or its members; it is the same group with a different label. Use set_form_permissions to change what it can do, and update_group_members to change who is in it.

Two kinds of group cannot be renamed here. Groups generated from the entries in a form take their names from the entry, and are renamed automatically when that entry changes, so a name set by hand would be overwritten; change the entry instead. The three groups the system relies on - Webmasters (group 1), Registered Users (group 2) and Anonymous Users (group 3) - cannot be renamed at all.

Properties

Property Type Required? Description
groups array of object Required

Required. The groups to change, and what to change about each.

← Back to the MCP reference