Skip to main content
Version: 3.102.8

Upsert user group

POST 
/groups-srv/usergroups

Creates or updates a user group. Pass groupId in the request body (not in the path).

PUT /groups-srv/usergroups uses the same handler. Prefer PUT when you intend to update an existing group; POST also upserts.

Do not call PUT /groups-srv/usergroups/{groupId} — that path only supports GET and DELETE and returns HTTP 405 for PUT.

Updatable Fields:

  • groupId: Required in the body; cannot be changed after creation (unique identifier)
  • groupName: Display name
  • groupType: Must reference an existing group type
  • parentId: "root" or a valid existing groupId (no circular references)
  • customFields: Updated, added, or removed
  • Visibility settings: memberProfileVisibility, noneMemberProfileVisibility
  • make_first_user_admin

Immutable Fields:

  • groupOwner: Cannot be set; defaults to client

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