# Update user group

**PUT /user-groups/{id}**

This API call is used to update all fields for the specified user group. 


## Servers
- Sandbox server URL: https://localhost:8080 (Sandbox server URL)


## Authentication methods
- Bearer auth


## Parameters

### Path parameters
- **id** (integer)
  User group ID.


### Body: application/json (object)

- **name** (string)
  Name of user group.
- **description** (string)
  Description of user group.
- **userGroupType** (string)

- **locationId** (string)
  The location code value.
- **departmentId** (string)
  The department code value.
- **defaultUser** (string)
  Username of default user of user group.
- **users** (array[string])
  List of usernames to add to user group.


## Responses
### 200
Success Response

#### Body: application/json (object)
- **id** (integer)
  Unique identifier of user group
- **name** (string)
  Name of user group.
- **status** (string)
  Status of user group processing.
- **message** (string)
  Status message of user group processing.

### 400
Failed Response

#### Body: application/json (object)
- **id** (integer)
  Unique identifier of user group
- **name** (string)
  Name of user group.
- **status** (string)
  Status of user group processing.
- **message** (string)
  Status message of user group processing.

### 401
Authentication Error. Invalid credentials.

#### Body: application/json (object)
- **code** (string)

- **message** (string)

- **description** (string)


### 403
Authorization Error. Invalid role for request.

### 404
Failed Response


[Powered by Bump.sh](https://bump.sh)