Sign in

v1

latestOpenAPI 3.0.32026-08-061874701.5 MB
automationRules

Update an automation rule

Updates an existing automation rule.

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

put/sheets/{sheetId}/automationrules/{automationRuleId}

Headers

Content-Typestring

Required for POST and PUT requests. Defines the structure for the request body.

Request body

idnumber

AutomationRule ID.

{"stackTrail":"components:schemas:AutomationRule:properties:action","oasType":"schema","type":"unknown","description":"An [AutomationAction object](/api/smartsheet/openapi/automationrules/automationaction) containing information for this rule, such as type, recipients, and frequency."}
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.

disabledReasonTextstring

Descriptive reason a rule is disabled.

enabledboolean

If true, indicates that the rule is active.

namestring

Rule name as shown in the UI.

userCanModifyboolean

If true, indicates that the current user can modify the rule.

Example request

{
  "createdBy": {
    "email": "jane.doe@smartsheet.com",
    "name": "Jane Doe"
  },
  "modifiedBy": {
    "email": "jane.doe@smartsheet.com",
    "name": "Jane Doe"
  }
}

Response

Result object containing the updated AutomationRule object

message'PARTIAL_SUCCESS' | 'SUCCESS'

Message that indicates the outcome of the request. (One of SUCCESS or PARTIAL_SUCCESS.)

resultCode0 | 3
  • '0' Success
  • '3' Partial Success of Bulk Operation
versionnumber nullable

New version of the sheet. Applicable only for operations which update sheet data.

Example response

{
  "message": "SUCCESS",
  "result": {
    "createdBy": {
      "email": "jane.doe@smartsheet.com",
      "name": "Jane Doe"
    },
    "modifiedBy": {
      "email": "jane.doe@smartsheet.com",
      "name": "Jane Doe"
    }
  }
}