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

# Import a new component group document

`POST /automation-studio/component-groups/import`

## Request

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

Imports a new component group document.

## Request body

- object
  - `componentGroups` AutomationStudioComponentGroupImport[]: Array of component group documents to import. If '_id' is provided, it will be replaced with an autogenerated '_id'. If a component group's name is already used in the component groups collection, it will be renamed with a numeric suffix.
    - `_id` string: Unique identifier of the component group
    - `name` string, required
    - `gbacRead` string[], required
    - `members` AutomationStudioComponentGroupImportMembersItems[], required
      - union
        - AutomationStudioComponentGroupImportMembersItems0
          - `path` string[]
          - `type` 'folder'
        - AutomationStudioComponentGroupImportMembersItems1
          - `path` string
          - `type` 'component'
          - `sourceCollection` string
          - `ref` string
    - `version` number, double
    - `meta` AutomationStudioComponentGroupImportMeta

## Response `200`

Results from each individual import operation.

- AutomationStudioImportComponentGroupsResponse200
  - `imported` AutomationStudioComponentGroupsImportPostResponsesContentApplicationJsonSchemaImportedItems[]
    - `success` boolean: Status flag denoting the success (true) or failure (false) of the component group's import operation.
    - `message` string, required: Message containing either confirmation of the import operation or the reason for the failure of the import operation.
    - `original` AutomationStudioComponentGroupImport, required: Data to import as a new component group document.
      - `_id` string: Unique identifier of the component group
      - `name` string, required
      - `gbacRead` string[], required
      - `members` AutomationStudioComponentGroupImportMembersItems[], required
        - union
          - AutomationStudioComponentGroupImportMembersItems0
            - `path` string[]
            - `type` 'folder'
          - AutomationStudioComponentGroupImportMembersItems1
            - `path` string
            - `type` 'component'
            - `sourceCollection` string
            - `ref` string
      - `version` number, double
      - `meta` AutomationStudioComponentGroupImportMeta
    - `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, nullable, required: URI to the edit page for the imported 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/import/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)