> ## Documentation Index
> Fetch the complete documentation index at: https://docs.galtea.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Update User Group

> Update an existing user group.

> [!WARNING]
>
> You are reading the docs of Galtea 5.14. [Read this page in the latest version](https://docs.galtea.ai/sdk/api/user-group/update.md).

Only an OWNER or ADMIN can update a user group.

## Returns

Returns the updated [User Group](https://docs.galtea.ai/v5.14/concepts/user-group.md) object.

## Example

```python theme={"system"}
user_group = galtea.user_groups.update(
    user_group_id=user_group_id,
    name="senior-quality-reviewers-" + run_identifier,
    description="Senior team for quality reviews",
)
```

### Set a permission list

```python theme={"system"}
# Give the group a list of product permissions: its members can do exactly these actions
# on the group's products, as far as their role allows.
user_group = galtea.user_groups.update(
    user_group_id=user_group_id,
    permissions=["product.read", "analytics.read", "analytics.readCoverage"],
)
```

### Remove the permission list

```python theme={"system"}
# None removes the custom list. Leaving `permissions` out keeps the current list.
user_group = galtea.user_groups.update(user_group_id=user_group_id, permissions=None)
```

## Parameters

**user\_group\_id** `string` *required*

The ID of the user group to update.

**name** `string`

New name for the user group.

**description** `string`

New description for the user group.

**all\_products** `boolean`

Links the group to every product of the organization, current and future. A MEMBER, READER or HUMAN\_EVALUATOR in the group then reaches every product.

**permissions** `list[string] | None`

The product permissions the group grants on its products, each written `entity.action`, for example `analytics.readCoverage`. A list replaces the current list, and an empty list grants nothing. Pass `None` to remove the custom list, so the group grants every permission the role of its members allows. Leave it out to keep the current list. The API answers 400 for an entry that cannot be granted, for an action without the `read` of its entity, for `evaluation.readInference` without `inferenceResult.read`, and for a non-empty list without `product.read`. See [permission lists](https://docs.galtea.ai/v5.14/concepts/user-group.md#permission-lists).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.