---
title: "Replace a component group document"
method: PUT
path: "/automation-studio/component-groups/{id}"
tags: ["Automation Studio"]
---

# Replace a component group document

`PUT /automation-studio/component-groups/{id}`

## Request

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

Replaces a component group document.

## Path parameters

- `id` string, required

## Request body

- object
  - `update` AutomationStudioComponentGroupUpdate: An entity representing an update to an existing template document.
    - `_id` string: Unique identifier of the component group
    - `name` string, required
    - `gbacRead` string[], required
    - `members` AutomationStudioComponentGroupUpdateMembersItems[], required
      - union
        - AutomationStudioComponentGroupUpdateMembersItems0
          - `path` string[]
          - `type` 'folder'
        - AutomationStudioComponentGroupUpdateMembersItems1
          - `path` string
          - `type` 'component'
          - `sourceCollection` string
          - `ref` string
    - `version` number, double
    - `meta` AutomationStudioComponentGroupUpdateMeta

## Response `200`

Response object.

- AutomationStudioUpdateComponentGroupResponse200
  - `updated` 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 updated 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/:id/put.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)