> For the complete documentation index, see [llms.txt](https://fusionauth.io/docs/llms.txt)

# Update a Group

API documentation for the FusionAuth Update a Group API.

# Update a Group

This API is used to update an existing Group.

You must specify all of the properties of the Group when calling this API with the `PUT` HTTP method. When used with `PUT`, this API doesn't merge the existing Group and your new data. It replaces the existing Group with your new data.

Utilize the `PATCH` HTTP method to send specific changes to merge into an existing Group.

## Request

[!API Key Authentication](https://fusionauth.io/docs/apis/authentication.md#api-key-authentication)

Update the Group with the given Id

PUT/api/group/{groupId}

OpenAPI Spec

### Request Parameters

`groupId`UUIDrequiredImmutable

The Id of the Group to update.

#### Request Headers

`X-FusionAuth-TenantId`Stringoptional

The unique Id of the tenant used to scope this API request.

The tenant Id is not required on this request even when more than one tenant has been configured because the tenant can be identified based upon the request parameters or it is otherwise not required.

Specify a tenant Id on this request when you want to ensure the request is scoped to a specific tenant. The tenant Id may be provided through this header or by using a tenant locked API key to achieve the same result.

See [Making an API request using a Tenant Id](https://fusionauth.io/docs/apis/authentication.md#making-an-api-request-using-a-tenant-id) for additional information.

#### Request Body

`group.data`Objectoptional

An object that can hold any information about the Group that should be persisted.

`group.name`Stringrequired

The name of the Group.

`roleIds`Array<UUID>optional

The Application Roles to assign to this group.

*Example Request JSON*

```json
{
  "group": {
    "data": {
      "description": "This group assigns members admin access to all applications.",
      "external": {
        "createdAt": 1503000771468
      }
    },
    "name": "Company Admins"
  },
  "roleIds": [
    "68259c40-0b4e-4245-8956-7e5af0959c2b",
    "00f24e72-52e2-4f55-8ea1-6a06bfe10df5",
    "11a5b1b8-7ef5-476f-af7d-69e19796fa8b"
  ]
}
```

## Response

The response for this API contains the Group that was updated.

*Response Codes*

| Code | Description |
| --- | --- |
| 200 | The request was successful. The response will contain a JSON body. |
| 400 | The request was invalid and/or malformed. The response will contain an [Errors](https://fusionauth.io/docs/apis/errors.md) JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present. |
| 401 | You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See [Authentication](https://fusionauth.io/docs/apis/authentication.md). |
| 404 | The object you are trying to update doesn't exist. The response will be empty. |
| 500 | There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty. |

#### Response Body

`group.data`Object

An object that can hold any information about the Group that should be persisted.

`group.id`UUID

The unique Id of the Group.

`group.insertInstant`Long

The [instant](https://fusionauth.io/docs/reference/data-types.md#instants) that the Group was added to the FusionAuth database.

`group.lastUpdateInstant`Long

The [instant](https://fusionauth.io/docs/reference/data-types.md#instants) that the Group was updated in the FusionAuth database.

`group.name`String

The name of the Group.

`group.roles`Map<UUID, List<Object>

The roles assigned to this Group. The map key is the Application Id, the value is an array of Application Roles.

`group.roles[applicationId][x].description`String

The description of the role.

`group.roles[applicationId][x].id`UUID

The Application Role Unique Id

`group.roles[applicationId][x].name`String

The name of the Group.

`group.roles[applicationId][x].isDefault`Boolean

Whether or not the Role is a default role. A default role is automatically assigned to a user during registration if no roles are provided.

`group.roles[applicationId][x].isSuperRole`Boolean

Whether or not the Role is a considered to be a super user role. This is a marker to indicate that it supersedes all other roles. FusionAuth will attempt to enforce this contract when using the web UI, it is not enforced programmatically when using the API.

`group.tenantId`UUID

The unique Id of the Tenant.

*Example Response JSON*

```json
{
  "group": {
    "data": {
      "description": "This group assigns members admin access to all applications.",
      "external": {
        "createdAt": 1503000771468
      }
    },
    "id": "1188edfc-cef3-4555-910e-181ddf6153c0",
    "insertInstant": 1595361142909,
    "lastUpdateInstant": 1595361143101,
    "name": "Company Admins",
    "roles": {
      "931fded0-f917-439d-b447-d7f21b37a134": [
        {
          "id": "68259c40-0b4e-4245-8956-7e5af0959c2b",
          "isDefault": false,
          "isSuperRole": true,
          "name": "admin"
        }
      ],
      "07d1efe7-9a14-433d-8247-2235e67736f0": [
        {
          "id": "00f24e72-52e2-4f55-8ea1-6a06bfe10df5",
          "isDefault": false,
          "isSuperRole": true,
          "name": "ADMIN"
        }
      ],
      "d23e9a51-2b20-4384-9c74-432e12219aad": [
        {
          "id": "11a5b1b8-7ef5-476f-af7d-69e19796fa8b",
          "isDefault": false,
          "isSuperRole": true,
          "name": "Administrator"
        }
      ]
    },
    "tenantId": "30663132-6464-6665-3032-326466613934"
  }
}
```