Skip to main content

Store many user groups

POST 
/groups-srv/bulk/usergroups

This API call bulk adds or updates user groups.

Operation Behavior:

  • Processes multiple user groups in a single API call
  • Each user group in the array is processed independently
  • If a user group with the same groupId already exists, it will be updated
  • If a user group with a new groupId is provided, it will be created
  • 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 comply with the same validation rules as individual user group creation/update:
    • groupId: Required, must be unique within the batch
    • groupName: Required, cannot be empty
    • groupType: Required, must reference an existing group type
    • parentId: Required, must be "root" or a valid existing groupId
    • groupOwner: Required, must be "client" or "admin"

Response Structure:

  • Returns a bulk update result containing:
    • Overall status of the operation
    • Individual results for each user group processed
    • Success/failure status and error messages for failed items

Business Rules:

  • All user groups in the batch must have groupOwner: client (admin-owned groups cannot be created via API)
  • Duplicate groupId values within the same batch will cause validation errors
  • The operation is not fully atomic - some items may succeed while others fail
  • Check the response to identify which user groups were successfully created/updated and which failed

Request​

Responses​

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