Skip to main content

Update user group

POST 
/groups-srv/usergroups

This API call stores user groups.

Updatable Fields:

  • groupId: Cannot be changed after creation (serves as unique identifier)
  • groupName: Can be updated to change the display name
  • groupType: Can be changed, but must reference an existing group type
  • parentId: Can be changed, but must be "root" or a valid existing groupId (no circular references)
  • customFields: Can be updated, added, or removed
  • Visibility settings: memberProfileVisibility, noneMemberProfileVisibility
  • make_first_user_admin: Can be updated

Immutable Fields:

  • groupOwner: Cannot be set, but will be client by default

Validation Rules:

  • groupId: Must exist
  • 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 (a group cannot be its own parent or ancestor)

Business Rules:

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

Request​

Responses​

OK - User group updated successfully