---
title: "Update Group"
method: PUT
path: "/groups/{groupName}"
tags: ["Groups"]
---

# Update Group

`PUT /groups/{groupName}`

## Request

- Base URL: `https://env.unqork.io/api/1.0`
- URL: `https://env.unqork.io/api/1.0/groups/{groupName}`
- Auth: OAuth 2
  - Client credentials
  - Password
  - Token URL: `https://xyzfinancial.unqork.io/api/1.0/oauth2/access_token`
- TypeScript: <https://skmtc.dev/unqork/apis/unqork-customer-api/docs/groups/:groupName/put.ts> (a function with typed inputs; its response is checked against the schema)

Updates a single group. Partial updates are supported.
### Authorization Required:
  - Designer Administrator

## Path parameters

- `groupName` string, required

## Request body

- GroupPut
  - `name` string
  - `description` string
  - `type` 'role_descendents' | 'own_role_and_descendents' | 'ignore_role': See Group Administration screen for definitions

## Response `200`

Group updated

- Group
  - `name` string
  - `description` string
  - `type` 'role_descendents' | 'own_role_and_descendents' | 'ignore_role': See Group Administration screen for definitions

## Other responses

- `default`: Error

---

[API](https://skmtc.dev/unqork/apis/unqork-customer-api.md) - [All operations](https://skmtc.dev/unqork/apis/unqork-customer-api/llms.txt) - [OpenAPI document](https://skmtc.dev/unqork/apis/unqork-customer-api/revisions/13dad4096373?raw)