UpdateNotificationScheduleRequest

A request or response body; the type column links to the schemas it refers to.

UpdateNotificationScheduleRequest

Fields to change; an omitted field is left as it is.

FieldTypeRequiredDescription
enabledbooleanno—
cadencestringno

`daily`: every day at the hour. `weekly`: on `weekday` only.

one of "daily" | "weekly"

weekdayintegerno

Day of the week, 0 = Sunday … 6 = Saturday; used when weekly.

minimum 0 · maximum 6

hourintegerno

Hour of the day, 0–23, on the wall clock of `timezone`.

minimum 0 · maximum 23

timezonestringno

IANA timezone the hour is read in.

1–64 characters

jsonExample
{
  "enabled": true,
  "cadence": "weekly",
  "weekday": 1,
  "hour": 7,
  "timezone": "America/New_York"
}