ScheduledActionsScheduleUpdate interface

Schedule properties for update (PATCH). All properties are optional so individual fields can be patched (merge semantics); omitting a property preserves the current value.

Properties

deadlineType

The type of deadline the scheduled action is supposed to follow for the schedule. If no value is passed, it will default to InitiateAt.

executionParameters

The execution parameters the scheduled action is supposed to follow

requestedDaysOfTheMonth

The days of the month the scheduled action is supposed to run on. If empty, it means it will run on every day of the month.

requestedMonths

The months the scheduled action is supposed to run on. If empty, it means it will run on every month.

requestedWeekDays

The week days the scheduled action is supposed to run on. If empty, it means it will run on every week day.

scheduledTime

The time the scheduled action is supposed to run on

timeZone

The timezone the scheduled time is specified on

Property Details

deadlineType

The type of deadline the scheduled action is supposed to follow for the schedule. If no value is passed, it will default to InitiateAt.

deadlineType?: string

Property Value

string

executionParameters

The execution parameters the scheduled action is supposed to follow

executionParameters?: RecurringScheduledActionsExecutionParameters

Property Value

requestedDaysOfTheMonth

The days of the month the scheduled action is supposed to run on. If empty, it means it will run on every day of the month.

requestedDaysOfTheMonth?: number[]

Property Value

number[]

requestedMonths

The months the scheduled action is supposed to run on. If empty, it means it will run on every month.

requestedMonths?: string[]

Property Value

string[]

requestedWeekDays

The week days the scheduled action is supposed to run on. If empty, it means it will run on every week day.

requestedWeekDays?: string[]

Property Value

string[]

scheduledTime

The time the scheduled action is supposed to run on

scheduledTime?: string

Property Value

string

timeZone

The timezone the scheduled time is specified on

timeZone?: string

Property Value

string