​
Example Usage

import { CustomMessageRule } from "syllable-sdk/models/components";

let value: CustomMessageRule = {
  description: "immediately geez justly pfft",
  timeRangeStart: "09:00",
  timeRangeEnd: "17:00",
  date: "2025-01-01",
  daysOfWeek: [
    "mo",
    "tu",
    "we",
    "th",
    "fr",
  ],
  invert: false,
  text: "Sorry, we're closed today",
};

​
Fields

FieldTypeRequiredDescriptionExample
descriptionstringTRUEThe description of the rule
timeRangeStartstringFALSEThe start of the time range for the rule in 24-hour format hh:mm (should be null for “all day” cases)09:00
timeRangeEndstringFALSEThe end of the time range for the rule in 24-hour format hh:mm (should be null for “all day” cases)17:00
datestringFALSEThe date for the rule in YYYY-MM-DD format2025-01-01
daysOfWeekcomponents.DayOfWeek[]FALSEThe days of the week for the rule[
“mo”,
“tu”,
“we”,
“th”,
“fr”
]
invertbooleanTRUEWhether the rule logic should be inverted (i.e. “not”)
textstringTRUEMessage text associated with the ruleSorry, we’re closed today
CustomMessageResponseCustomMessageUpdateRequest