Type Alias ScheduleRequestObject

type ScheduleRequestObject = {
    interval?: number;
    recurrence?: string;
    startAt?: string | null;
    stopAt?: string | null;
    timezone?: string;
}
Index
interval? recurrence? startAt? stopAt? timezone?
interval?: number

Interval in seconds; must be a multiple of 60. Values are rounded to the nearest minute (≥30 seconds rounded up, otherwise down).

recurrence?: string

The RRULE that defines when the automation runs. When provided, it takes precedence over interval.

startAt?: string | null

The date and time when the schedule becomes active. If null, any existing start date is removed and the schedule is active from now. If omitted, an existing start date that is still in the future is removed; one that is already in the past is kept.

stopAt?: string | null

The date and time until the schedule is active. If omitted or null, any existing end date is removed.

timezone?: string

Settings
Member Visibility

On This Page
Properties