Methods

List All Automation Rules

Returns all automation rules associated with the specified sheet.

Multistep workflows are not returned via the API. Instead, you'll see an error 400 - 1266: This rule is not accessible through the API. Only single-action notifications, approval requests, or update requests qualify.

For users of Smartsheet for Slack, note that Slack notifications are not returned.

Authorizations:

APITokenOAuth2 (READ_SHEETS)

path Parameters

sheetId

required

number

Sheet Id of the sheet being accessed.

query Parameters

includeAll	boolean Default: false If true, include all results, that is, do not paginate. Mutually exclusive with page and pageSize (they are ignored if includeAll=true is specified).
page	number Default: 1 Which page to return. Defaults to 1 if not specified. If you specify a value greater than the total number of pages, you'll receive an empty data set.
pageSize	number Default: 100 The maximum number of items to return per page. Unless otherwise stated for a specific endpoint, defaults to 100. If only page is specified, defaults to a page size of 100. For reports, the default is 100 rows. If you need larger sets of data from your report, returns a maximum of 10,000 rows per request.

header Parameters

Authorization

string

API Access Token used to authenticate requests to Smartsheet APIs.

Example: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789

Responses

Request samples

cURL
C#
Node.js
Python
Ruby

curl https://api.smartsheet.com/2.0/sheets/{sheetId}/automationrules \
-H "Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789"

Response samples

200

Content type

application/json

{"pageNumber": 1,
"pageSize": 50,
"totalPages": 25,
"totalCount": 136,
"data": [{"id": 0,
"action": null,
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": {"email": "jane.doe@smartsheet.com",
"name": "Jane Doe"
},
"disabledReason": "APPROVAL_COLUMN_MISSING",
"disabledReasonText": "string",
"enabled": true,
"modifiedAt": "2019-08-24T14:15:22Z",
"modifiedBy": {"email": "jane.doe@smartsheet.com",
"name": "Jane Doe"
},
"name": "string",
"userCanModify": true
}
]
}

Get an Automation Rule

Returns the specified automation rule, including any action values.

Authorizations:

APITokenOAuth2 (READ_SHEETS)

path Parameters

sheetId required	number Sheet Id of the sheet being accessed.
automationRuleId required	string The Id of an Automation Rule

header Parameters

Authorization

string

API Access Token used to authenticate requests to Smartsheet APIs.

Example: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789

Responses

Request samples

cURL
C#
Node.js
Python
Ruby

curl https://api.smartsheet.com/2.0/sheets/{sheetId}/automationrules/{automationRuleId} \
 -H "Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789"

Response samples

200

Content type

application/json

{"id": 0,
"action": null,
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": {"email": "jane.doe@smartsheet.com",
"name": "Jane Doe"
},
"disabledReason": "APPROVAL_COLUMN_MISSING",
"disabledReasonText": "string",
"enabled": true,
"modifiedAt": "2019-08-24T14:15:22Z",
"modifiedBy": {"email": "jane.doe@smartsheet.com",
"name": "Jane Doe"
},
"name": "string",
"userCanModify": true
}

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.

Authorizations:

APITokenOAuth2 (WRITE_SHEETS)

path Parameters

sheetId required	number Sheet Id of the sheet being accessed.
automationRuleId required	string The Id of an Automation Rule

header Parameters

Authorization	string API Access Token used to authenticate requests to Smartsheet APIs. Example: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789
Content-Type	string Default: application/json Required for POST and PUT requests. Defines the structure for the request body.

Request Body schema: application/json

any

Responses

Request samples

Content type

application/json

{"id": 0,
"action": null,
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": {"email": "jane.doe@smartsheet.com"
},
"disabledReason": "APPROVAL_COLUMN_MISSING",
"disabledReasonText": "string",
"enabled": true,
"modifiedAt": "2019-08-24T14:15:22Z",
"modifiedBy": {"email": "jane.doe@smartsheet.com"
},
"name": "string",
"userCanModify": true
}

Response samples

200

Content type

application/json

{"version": 0,
"failedItems": [{"rowId": 0,
"error": {"refId": "string",
"errorCode": 0,
"message": "string"
},
"index": 0
}
],
"message": "SUCCESS",
"resultCode": 0,
"result": {"id": 0,
"action": null,
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": {"email": "jane.doe@smartsheet.com",
"name": "Jane Doe"
},
"disabledReason": "APPROVAL_COLUMN_MISSING",
"disabledReasonText": "string",
"enabled": true,
"modifiedAt": "2019-08-24T14:15:22Z",
"modifiedBy": {"email": "jane.doe@smartsheet.com",
"name": "Jane Doe"
},
"name": "string",
"userCanModify": true
}
}

Delete an Automation Rule

Deletes an automation rule.

Authorizations:

APITokenOAuth2 (WRITE_SHEETS)

path Parameters

sheetId required	number Sheet Id of the sheet being accessed.
automationRuleId required	string The Id of an Automation Rule

header Parameters

Authorization

string

API Access Token used to authenticate requests to Smartsheet APIs.

Example: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789

Responses

Request samples

cURL
C#
Node.js
Python
Ruby

curl https://api.smartsheet.com/2.0/sheets/{sheetId}/automationrules/{automationRuleId} \
-H "Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789" \
-X DELETE

Response samples

200

Content type

application/json

{"version": 0,
"failedItems": [{"rowId": 0,
"error": {"refId": "string",
"errorCode": 0,
"message": "string"
},
"index": 0
}
],
"message": "SUCCESS",
"resultCode": 0
}