---
title: "Create Group"
method: POST
path: "/groups"
tags: ["Groups"]
---

# Create Group

`POST /groups`

## Request

- Base URL: `https://env.unqork.io/api/1.0`
- URL: `https://env.unqork.io/api/1.0/groups`
- 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/post.ts> (a function with typed inputs; its response is checked against the schema)

Creates a new group.
### Authorization Required:
  - Designer Administrator

## Request body

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

## Response `201`

Group created

- 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)