Skip to main content

Update multiple user groups

PUT 
/groups-srv/bulk/usergroups

This API call bulk updates existing user groups. All groups must already exist.

Operation Behavior:

  • Updates multiple existing user groups in a single API call
  • All user groups in the array must already exist (cannot create new groups)
  • Each user group is processed independently
  • The operation continues processing even if individual items fail

Validation Rules:

  • Request body must be a valid JSON array
  • Array must contain at least one user group object
  • Each user group must have a groupId that exists in the system
  • Each user group must comply with update validation rules:
    • groupId: Required, must exist in the system
    • groupName: Optional, if provided cannot be empty
    • groupType: Optional, if provided must reference an existing group type
    • parentId: Optional, if provided must be "root" or a valid existing groupId
    • groupOwner: Cannot be changed (immutable)

Business Rules:

  • This endpoint only updates existing groups - use POST for creating new groups
  • All groups in the batch must have groupOwner: client (admin-owned groups cannot be updated via API)
  • The groupId and groupOwner fields cannot be changed
  • The operation is not fully atomic - some items may succeed while others fail
  • Check the response to identify which user groups were successfully updated and which failed

Request​

Responses​

OK - Bulk update operation completed. Check the response for individual success/failure status of each user group.