---
title: "Update an automation rule"
method: PUT
path: "/sheets/{sheetId}/automationrules/{automationRuleId}"
tags: ["automationRules"]
---

# Update an automation rule

`PUT /sheets/{sheetId}/automationrules/{automationRuleId}`

Updates an existing automation rule.

When sending an AutomationRule, you must always specify **action.type** and it must match the existing rule type.

## Headers

- `Content-Type` string

## Request body

- AutomationRule
  - `id` number — AutomationRule ID.
  - `action` unknown
  - `createdAt` union
    - string, date-time
    - number
  - `createdBy` MiniUser — MiniUser Object
    - `email` string, email
    - `name` string
  - `disabledReason` 'APPROVAL_COLUMN_MISSING' | 'APPROVAL_COLUMN_WRONG_TYPE' | 'AUTOMATION_NOT_ENABLED_FOR_ORG' | 'COLUMN_MISSING' | 'COLUMN_TYPE_INCOMPATIBLE' | 'NO_POTENTIAL_RECIPIENTS' | 'NO_VALID_SELECTED_COLUMNS' — Machine-readable reason a rule is disabled: * `APPROVAL_COLUMN_MISSING` This rule's approval status column has been deleted. * `APPROVAL_COLUMN_WRONG_TYPE` The approval column must be a dropdown column. * `AUTOMATION_NOT_ENABLED_FOR_ORG` To create or edit automated actions, you need to upgrade your organization account to a Business or Enterprise plan. * `COLUMN_MISSING` A column referenced by this rule has been deleted. * `COLUMN_TYPE_INCOMPATIBLE` A column referenced by this rule has been changed to an incompatible column type. * `NO_POTENTIAL_RECIPIENTS` This rule has no recipients that will be able to receive notifications based on this sheet's permission settings or this account's approved domain sharing list. * `NO_VALID_SELECTED_COLUMNS` All selected columns for this rule have been deleted.
  - `disabledReasonText` string — Descriptive reason a rule is disabled.
  - `enabled` boolean — If true, indicates that the rule is active.
  - `modifiedAt` union
    - string, date-time
    - number
  - `modifiedBy` MiniUser — MiniUser Object
    - `email` string, email
    - `name` string
  - `name` string — Rule name as shown in the UI.
  - `userCanModify` boolean — If true, indicates that the current user can modify the rule.

## Response `200`

Result object containing the updated AutomationRule object

- object
  - `message` 'PARTIAL_SUCCESS' | 'SUCCESS' — Message that indicates the outcome of the request. (One of `SUCCESS` or `PARTIAL_SUCCESS`.)
  - `resultCode` 0 | 3 — * '0' Success * '3' Partial Success of Bulk Operation
  - `failedItems` BulkItemFailure[], nullable — Array of BulkItemFailure objects which represents the items that failed to be added or updated. See [Bulk operations > Partial success](/api/smartsheet/guides/advanced-topics/scalability-options) for more information. Applicable only for bulk operations that support partial success.
    - `rowId` number, nullable — The ID of the row that failed. Applicable only to bulk row operations.
    - `error` Error — The error caused by the failed item.
      - `refId` string — The ID of the specific error occurrence. Please include this information when contacting Smartsheet support.
      - `errorCode` number — Custom error code from Smartsheet. See the complete [Error Code List](/api/smartsheet/error-codes).
      - `message` string — Descriptive error message.
    - `index` number — The index of the failed item in the bulk request array.
  - `version` number, nullable — New version of the sheet. Applicable only for operations which update sheet data.
  - `result` AutomationRule
    - `id` number — AutomationRule ID.
    - `action` unknown
    - `createdAt` union
      - string, date-time
      - number
    - `createdBy` MiniUser — MiniUser Object
      - `email` string, email
      - `name` string
    - `disabledReason` 'APPROVAL_COLUMN_MISSING' | 'APPROVAL_COLUMN_WRONG_TYPE' | 'AUTOMATION_NOT_ENABLED_FOR_ORG' | 'COLUMN_MISSING' | 'COLUMN_TYPE_INCOMPATIBLE' | 'NO_POTENTIAL_RECIPIENTS' | 'NO_VALID_SELECTED_COLUMNS' — Machine-readable reason a rule is disabled: * `APPROVAL_COLUMN_MISSING` This rule's approval status column has been deleted. * `APPROVAL_COLUMN_WRONG_TYPE` The approval column must be a dropdown column. * `AUTOMATION_NOT_ENABLED_FOR_ORG` To create or edit automated actions, you need to upgrade your organization account to a Business or Enterprise plan. * `COLUMN_MISSING` A column referenced by this rule has been deleted. * `COLUMN_TYPE_INCOMPATIBLE` A column referenced by this rule has been changed to an incompatible column type. * `NO_POTENTIAL_RECIPIENTS` This rule has no recipients that will be able to receive notifications based on this sheet's permission settings or this account's approved domain sharing list. * `NO_VALID_SELECTED_COLUMNS` All selected columns for this rule have been deleted.
    - `disabledReasonText` string — Descriptive reason a rule is disabled.
    - `enabled` boolean — If true, indicates that the rule is active.
    - `modifiedAt` union
      - string, date-time
      - number
    - `modifiedBy` MiniUser — MiniUser Object
      - `email` string, email
      - `name` string
    - `name` string — Rule name as shown in the UI.
    - `userCanModify` boolean — If true, indicates that the current user can modify the rule.

---

[API](https://skmtc.net/smartsheet/apis/smartsheet-openapi-reference.md) · [All operations](https://skmtc.net/smartsheet/apis/smartsheet-openapi-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/smartsheet/smartsheet-openapi-reference/versions/b4afda95fb51/schema)