---
title: "Create a new component group document"
method: POST
path: "/automation-studio/component-groups"
tags: ["Automation Studio"]
---

# Create a new component group document

`POST /automation-studio/component-groups`

## Request

- Base URL: `https://example.itential.io`
- URL: `https://example.itential.io/automation-studio/component-groups`
- Auth: none declared

Creates a new component group document.

## Request body

- object
  - `componentGroup` AutomationStudioComponentGroup: An entity representing a component group.
    - `_id` string: Unique identifier of the component group
    - `name` string, required
    - `description` string
    - `gbacRead` string[], required
    - `gbacWrite` string[]
    - `members` AutomationStudioComponentGroupMembersItems[], required
      - union
        - AutomationStudioComponentGroupMembersItems0
          - `path` string[]
          - `type` 'folder'
        - AutomationStudioComponentGroupMembersItems1
          - `path` string
          - `type` 'component'
          - `sourceCollection` string
          - `ref` string
    - `version` number, double
    - `meta` AutomationStudioComponentGroupMeta

## Response `200`

Created component group and associated edit URI.

- AutomationStudioCreateComponentGroupResponse200: Created component group and associated edit URI.
  - `created` AutomationStudioComponentGroup, required: An entity representing a component group.
    - `_id` string: Unique identifier of the component group
    - `name` string, required
    - `description` string
    - `gbacRead` string[], required
    - `gbacWrite` string[]
    - `members` AutomationStudioComponentGroupMembersItems[], required
      - union
        - AutomationStudioComponentGroupMembersItems0
          - `path` string[]
          - `type` 'folder'
        - AutomationStudioComponentGroupMembersItems1
          - `path` string
          - `type` 'component'
          - `sourceCollection` string
          - `ref` string
    - `version` number, double
    - `meta` AutomationStudioComponentGroupMeta
  - `edit` string, required: URI to the edit page for the newly created component group.

## Other responses

- `500`: Error response from API

## Changes

- **2026-10-31** `2095cc90e583`: 2 info
  - api tag `Automation Studio` added
  - api tag `automationStudio` removed

[Operation history](https://skmtc.dev/itential/apis/itential-2/changes/automation-studio/component-groups/post.md)

---

[API](https://skmtc.dev/itential/apis/itential-2.md) - [All operations](https://skmtc.dev/itential/apis/itential-2/llms.txt) - [OpenAPI document](https://skmtc.dev/itential/apis/itential-2/revisions/2095cc90e583?raw)