Smartsheet logo

Objects

AutomationRule Object

id
number

AutomationRule Id.

action
any

An AutomationAction object containing information for this rule, such as type, recipients, and frequency.

string or number

A timestamp of when the rule was originally added.

object

User object containing name and email of the creator of this rule.

disabledReason
string

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.

Enum: "APPROVAL_COLUMN_MISSING" "APPROVAL_COLUMN_WRONG_TYPE" "AUTOMATION_NOT_ENABLED_FOR_ORG" "COLUMN_MISSING" "COLUMN_TYPE_INCOMPATIBLE" "NO_POTENTIAL_RECIPIENTS" "NO_VALID_SELECTED_COLUMNS"
disabledReasonText
string

Descriptive reason a rule is disabled.

enabled
boolean

If true, indicates that the rule is active.

string or number

The datetime for when the change was made to the rule.

object

User object containing the name and email of the user that made the change.

name
string

Rule name as shown in the UI.

userCanModify
boolean

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

{
  • "id": 0,
  • "action": null,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    },
  • "disabledReason": "APPROVAL_COLUMN_MISSING",
  • "disabledReasonText": "string",
  • "enabled": true,
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "name": "string",
  • "userCanModify": true
}

AutomationAction Object

One of
notifyAllSharedUsers
boolean

If true, notifications are sent to all users shared to the sheet.

includedColumnIds
Array of numbers

Specifies which columns to include in message.

type
string
Enum: "APPROVAL_REQUEST_ACTION" "NOTIFICATION_ACTION" "UPDATE_REQUEST_ACTION"
frequency
string
Enum: "DAILY" "HOURLY" "IMMEDIATELY" "WEEKLY"
includeAllColumns
boolean
Default: true

If true, all columns are included in email contents.

includeAttachments
string

If true, all attachments are included in email contents.

includeDiscussions
boolean

If true, all discussions are included in email contents.

message
string

Email body.

subject
string

Email subject line.

{
  • "recipientColumnIds": [
    ],
  • "includedColumnIds": [
    ],
  • "type": "APPROVAL_REQUEST_ACTION",
  • "frequency": "DAILY",
  • "includeAllColumns": true,
  • "includeAttachments": "string",
  • "includeDiscussions": true,
  • "message": "string",
  • "subject": "string"
}
➔ Next to Methods