Docs

Update Rule

PUT /rule-sets/{ruleSetId}/rules/{ruleId}

PUT/rule-sets/{ruleSetId}/rules/{ruleId}

Replaces a rule's fields; changing priority shifts the sibling rules' priorities to keep them ordered. A TimeOfDayWindow rule is live on a day when the weekday is in daysOfWeek or the day matches an entry in annualDates; with neither set it is live every day, and with dates only it is live on those dates alone. A date matches the actual calendar day, never a weekend observance. Requires ResourceTypeDatabase.Edit.

Path Parameters

FieldTypeRequiredDescription
ruleSetIduuidRequired
ruleIduuidRequired

Request Body

FieldTypeRequiredDescription
namestringOptional
descriptionstringOptional
priorityintegerOptional
conditionTypestringOptional
trackedBlockTypeIduuidOptional
isActivebooleanOptional
windowStarttimeOptional
windowEndtimeOptional
resultingStateIduuidOptional
daysOfWeekstring[]Optional
annualDatesstring[]Optional