Skip to main content
Version: 3.102.8

Update user group

PUT 
/groups-srv/usergroups

Updates a user group (upsert). Pass groupId in the request body — it is not a path parameter on this endpoint.

Example:

PUT /groups-srv/usergroups

{
  "groupId": "your-group-id",
  "groupName": "New name",
  "groupType": "CustomerGroupType",
  "parentId": "root"
}

The same handler is available as POST /groups-srv/usergroups.

Do not use PUT /groups-srv/usergroups/{groupId}. That path only registers GET and DELETE; PUT returns HTTP 405.

Updatable Fields:

  • groupName, groupType, parentId, customFields
  • Visibility settings: memberProfileVisibility, noneMemberProfileVisibility
  • make_first_user_admin

Immutable Fields:

  • groupId (identifier in the body; cannot be renamed via this API)
  • groupOwner

Validation Rules:

  • groupId: Required in the body
  • groupName: If provided, cannot be empty
  • groupType: If provided, must reference an existing group type
  • parentId: If provided, must be "root" or a valid existing groupId
  • Circular references are not allowed

Business Rules:

  • When changing groupType, ensure the new groupType's roleMode allows roles currently assigned in this group
  • When changing parentId, the new parent must exist and must not create circular references
  • System-managed user groups (groupOwner: admin) cannot be updated via API

Request​

Responses​

OK - User group updated successfully