---
title: "Update existing group with input information. If not specified in the input, the existing value will be kept intact"
method: PUT
path: "/api/2.0/groups/{objectId}"
tags: ["Group Management API"]
---

# Update existing group with input information. If not specified in the input, the existing value will be kept intact

`PUT /api/2.0/groups/{objectId}`

## Request

- Base URL: `https://app.agenticbi.com` (the document declares no server; this is the origin it was published from)
- URL: `https://app.agenticbi.com/api/2.0/groups/{objectId}`
- Auth: HTTP bearer

## Path parameters

- `objectId` integer, required

## Request body

- UserGroup: User group information
  - `createdDate` integer: Created date in milliseconds
  - `lastModDate` integer: Last modified date
  - `id` integer: Group ID
  - `groupName` string, required: Group name
  - `userName` string: Group owner's username
  - `userId` integer: Group owner's user ID
  - `limitSharing` boolean: If true, this user can only share assets with members of this group
  - `accessLevel` integer: User's access level for this group (0=Admin, 1=Edit, 2=View)
  - `contentFilters` Filter[]: Group content filters
    - `fieldName` string, required: Filter field name. Either fieldName or fieldNames has to be not empty
    - `fieldNames` string[], required: Filter field names in case of tree filter. Either fieldName or fieldNames has to be not empty
    - `values` object[]: Filter values
    - `operator` string: Filter operator
    - `locked` boolean: Whether or not filter is locked (ie: not modifiable)
    - `requireValue` boolean: Whether or not filter requires value to be set
    - `enabled` boolean: Whether or not filter is enabled (default is true)
    - `controlType` string: Filter control type
    - `visible` boolean: Whether or not filter is visible (default is true)
    - `hitList` integer: Suggestion values dataset ID
    - `hitListLabel` string: Suggestion label field name of the hit list dataset
    - `hitListValue` string: Suggestion value field name of the hit list dataset
    - `filteringResult` boolean: Whether the filter should be applied before (false) or after (true) the widget data has been processed
    - `label` string: Display label for the filter
    - `or` boolean: Whether this filter is OR'd with the previous filter (for SQL parsing)
    - `description` string: Filter description
    - `dateLimit` string: Filter date limit
    - `dateLimitOptions` string: Filter date limit options (restriction and from token)
    - `displayValues` object[]: Custom display values
    - `plainControlType` string: Control type for plain text field type
    - `dynamic` boolean: Whether or not filter's value is automatically selected
    - `inclusiveTime` boolean: Whether time range filter is inclusive (includes exact start/end times, where start time is for Start Date and end time for End Date. UI tooltip: When checked, creates a single continuous time period from Start Date/Time to End Date/Time. When unchecked, applies the time range to each day separately (e.g., 9:00-17:00 every day within the date range).)
    - `groupHeading` boolean: Whether this entry is a display-only group heading (fieldName contains the heading text)
    - `divider` boolean: Whether this entry is a display-only divider between filter groups

## Response `200`

Success

- UserGroup: User group information
  - `createdDate` integer: Created date in milliseconds
  - `lastModDate` integer: Last modified date
  - `id` integer: Group ID
  - `groupName` string, required: Group name
  - `userName` string: Group owner's username
  - `userId` integer: Group owner's user ID
  - `limitSharing` boolean: If true, this user can only share assets with members of this group
  - `accessLevel` integer: User's access level for this group (0=Admin, 1=Edit, 2=View)
  - `contentFilters` Filter[]: Group content filters
    - `fieldName` string, required: Filter field name. Either fieldName or fieldNames has to be not empty
    - `fieldNames` string[], required: Filter field names in case of tree filter. Either fieldName or fieldNames has to be not empty
    - `values` object[]: Filter values
    - `operator` string: Filter operator
    - `locked` boolean: Whether or not filter is locked (ie: not modifiable)
    - `requireValue` boolean: Whether or not filter requires value to be set
    - `enabled` boolean: Whether or not filter is enabled (default is true)
    - `controlType` string: Filter control type
    - `visible` boolean: Whether or not filter is visible (default is true)
    - `hitList` integer: Suggestion values dataset ID
    - `hitListLabel` string: Suggestion label field name of the hit list dataset
    - `hitListValue` string: Suggestion value field name of the hit list dataset
    - `filteringResult` boolean: Whether the filter should be applied before (false) or after (true) the widget data has been processed
    - `label` string: Display label for the filter
    - `or` boolean: Whether this filter is OR'd with the previous filter (for SQL parsing)
    - `description` string: Filter description
    - `dateLimit` string: Filter date limit
    - `dateLimitOptions` string: Filter date limit options (restriction and from token)
    - `displayValues` object[]: Custom display values
    - `plainControlType` string: Control type for plain text field type
    - `dynamic` boolean: Whether or not filter's value is automatically selected
    - `inclusiveTime` boolean: Whether time range filter is inclusive (includes exact start/end times, where start time is for Start Date and end time for End Date. UI tooltip: When checked, creates a single continuous time period from Start Date/Time to End Date/Time. When unchecked, applies the time range to each day separately (e.g., 9:00-17:00 every day within the date range).)
    - `groupHeading` boolean: Whether this entry is a display-only group heading (fieldName contains the heading text)
    - `divider` boolean: Whether this entry is a display-only divider between filter groups

## Other responses

- `400`: Bad request
- `401`: User is not authenticated
- `403`: User is not allowed to access this resource
- `500`: Error during processing

---

[API](https://skmtc.dev/agenticbi/apis/user-management-api.md) · [All operations](https://skmtc.dev/agenticbi/apis/user-management-api/llms.txt) · [OpenAPI document](https://skmtc.dev/agenticbi/apis/user-management-api/revisions/62c42a99830e?raw)