---
title: "Update automation"
method: PATCH
path: "/operations-manager/automations/{id}"
tags: ["Operations Manager"]
---

# Update automation

`PATCH /operations-manager/automations/{id}`

## Request

- Base URL: `https://example.itential.io`
- URL: `https://example.itential.io/operations-manager/automations/{id}`
- Auth: none declared

Updates an Automation.

## Path parameters

- `id` string, required: A string which is formatted like an ObjectId, Distinct from an actual ObjectId.

## Request body

- OperationsManagerAutomationUpdate: The format of accepted input for an update operation on an Automation document.
  - `name` string: The name of the document
  - `description` string: The description of the document
  - `componentType` union: The type of component linked to this Automation.
    - unknown
    - unknown
    - unknown
    - unknown
  - `gbac` OperationsManagerAutomationUpdateGbac
    - `write` string[], required: An array of group ids that have write access to the Automation.
    - `read` string[], required: An array of group ids that have read/execute access to the Automation.
  - `componentId` union: The id of the component linked to this Automation.
    - string
    - string
    - unknown

## Response `200`

The result of the update operation.

- OperationsManagerUpdateAutomationResponse200: A success response from an API method
  - `message` string, required: A human-readable message summarizing the result of the operation
  - `data` unknown, required
  - `metadata` object, required: Any structured, wordy or machine-readable information related to the result of the operation. For success responses, this may contain information like pagination values from a search operation.

## Other responses

- `500`: Error response from API

## Changes

- **2026-10-31** `2095cc90e583`: 2 info
  - api tag `Operations Manager` added
  - api tag `operationsManager` removed

[Operation history](https://skmtc.dev/itential/apis/itential-2/changes/operations-manager/automations/:id/patch.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)