---
title: "Create teammate group"
method: POST
path: "/teammate_groups"
tags: ["Teammate groups"]
---

# Create teammate group

`POST /teammate_groups`

Create a new teammate group.

Required scope: `teammate_groups:write`

## Request body

- CreateTeammateGroup
  - `name` string, required — Name of the teammate group
  - `description` string — Description of the teammate group
  - `permissions` object — Permissions for the teammate group
    - `contacts` object — Permissions for accessing contact lists. This only applies if shared contacts permissions are enabled.
      - `access` string, required — One of 'all', 'contact_groups', 'contact_lists', or 'none'.
      - `contact_group_ids` string[] — List of contact group ids. Can only be specified if access is set to 'contact_groups'. ⚠️ Deprecated. Use access 'contact_lists' and 'contact_list_ids' instead.
      - `contact_list_ids` string[] — List of contact list ids. Can only be specified if access is set to 'contact_lists'.

## Response `201`

A teammate group

- TeammateGroupResponse — A teammate group is a group of teammates in Front.
  - `_links` object, required
    - `self` string — Link to resource
    - `related` object
      - `teammates` string — Link to list of teammate members
      - `teams` string — Link to list of associated teams
      - `inboxes` string — Link to list of inboxes that teammate members can access
  - `id` string, required — Unique identifier of the teammate group
  - `name` string, required — The name of the teammate group
  - `description` string, nullable, required — Description of the teammate group
  - `is_managed_by_scim` boolean, required — Is teammate group managed by SCIM or by Front
  - `permissions` object, required — Permissions for the teammate group
    - `contacts` object — Permissions for teammate group access to contact lists
      - `access` string — Level of access for the teammate group to contact lists. Must be one of 'all', 'contact_lists', or 'none'.
      - `contact_list_ids` string[] — List of contact lists the teammate group is allowed to access. May only be specified if 'access' is set to 'contact_lists'.

---

[API](https://skmtc.net/frontapp/apis/core-api.md) · [All operations](https://skmtc.net/frontapp/apis/core-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/frontapp/core-api/versions/76d1eaa2d0eb/schema)