Rules

Update a Rule

Update the logic and action of a specified Rule.

put/rules/{ruleId}

Request

Base URL
https://api.smartthings.com/v1
Auth
OAuth 2
Implicithttps://auth-global.api.smartthings.com
Scopesw:rules:*
TypeScript
https://skmtc.dev/smartthings/apis/smartthings-api/docs/rules/:ruleId/put.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

locationIdstring ^(?:([0-9a-fA-F]{32})|([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}))$ required

The ID of the Location that contains the Rule.

Request body

namestring required

The name for the Rule. Limit 100 characters.

timeZoneIdstring

The time zone ID for this Rule. This overrides the Location time zone ID, but is overridden by time zone ID provided by each operand individually.

Response

The Rule

namestring required

The name for the Rule. Limit 100 characters.

timeZoneIdstring

The time zone ID for this Rule. This overrides the Location time zone ID, but is overridden by time zone ID provided by each operand individually.

idstring ^(?:([0-9a-fA-F]{32})|([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}))$ required

Unique id for the Rule

status'Enabled' | 'Disabled'

The status of the Rule

executionLocation'Cloud' | 'Local'

The location where the rule is executing, either local or cloud

ownerIdstring required

Owner id

ownerType'Location' | 'User' required

The owner of the rule is either a location or user

creator'SMARTTHINGS' | 'ARB' | 'RECIPE' | 'UNDEFINED'

The creator name who create the behavior

dateCreatedstring required

Created date time

dateUpdatedstring required

Last updated date time

dateExecutedstring

Last executed date time

allowedstring[]

List of client-facing action identifiers that are currently permitted for the user. If the value of this property is not null, then any action not included in the list value of the property is currently prohibited for the user. If the value of this property is null (or absent), then no permission-related information is being provided.

<ul> <li> w:rules - the user can edit the rule <li> x:rules - the user can execute the rule <li> d:rules - the user can delete the rule </ul>

Changes

No recorded changes to this operation across all 8 revisions of this API.