set_schedule: Set a Schedule

In connectapi: Utilities for Interacting with the 'Posit Connect' Server API

Set a Schedule

Description

Sets the schedule for a given Variant. Requires a Schedule object (as returned by get_variant_schedule())

Usage

set_schedule(.schedule, ...)

set_schedule_minute(
  .schedule,
  n = 30,
  start_time = Sys.time(),
  activate = TRUE,
  email = FALSE,
  timezone = Sys.timezone()
)

set_schedule_hour(
  .schedule,
  n = 1,
  start_time = Sys.time(),
  activate = TRUE,
  email = FALSE,
  timezone = Sys.timezone()
)

set_schedule_day(
  .schedule,
  n = 1,
  start_time = Sys.time(),
  activate = TRUE,
  email = FALSE,
  timezone = Sys.timezone()
)

set_schedule_weekday(
  .schedule,
  start_time = Sys.time(),
  activate = TRUE,
  email = FALSE,
  timezone = Sys.timezone()
)

set_schedule_week(
  .schedule,
  n = 1,
  start_time = Sys.time(),
  activate = TRUE,
  email = FALSE,
  timezone = Sys.timezone()
)

set_schedule_dayofweek(
  .schedule,
  days,
  start_time = Sys.time(),
  activate = TRUE,
  email = FALSE,
  timezone = Sys.timezone()
)

set_schedule_semimonth(
  .schedule,
  first = TRUE,
  start_time = Sys.time(),
  activate = TRUE,
  email = FALSE,
  timezone = Sys.timezone()
)

set_schedule_dayofmonth(
  .schedule,
  n = 1,
  day = 1,
  start_time = Sys.time(),
  activate = TRUE,
  email = FALSE,
  timezone = Sys.timezone()
)

set_schedule_dayweekofmonth(
  .schedule,
  n = 1,
  day = 1,
  week = 1,
  start_time = Sys.time(),
  activate = TRUE,
  email = FALSE,
  timezone = Sys.timezone()
)

set_schedule_year(
  .schedule,
  n = 1,
  start_time = Sys.time(),
  activate = TRUE,
  email = FALSE,
  timezone = Sys.timezone()
)

set_schedule_remove(.schedule)

schedule_describe(.schedule)

Arguments

.schedule	A schedule object. As returned by get_variant_schedule()
...	Scheduling parameters
n	The "number of" iterations
start_time	The start time of the schedule
activate	This parameter no longer has any effect due to changes in the Connect API and will be removed in a future release.
email	Whether to send emails on this schedule
timezone	The timezone to use for setting the schedule. Defaults to Sys.timezone()
days	The days of the week (0-6)
first	logical Whether to execute on the 1st and 15th (TRUE) or 14th and last (FALSE)
day	The day of the week (0-6) or day of the month (0-31)
week	The week of the month (0-5)
schedule	A JSON blob (as a string) describing the schedule. See "More Details"

Details

• set_schedule() is a raw interface to Posit Connect's schedule API

• ⁠set_schedule_*()⁠ functions provide handy wrappers around set_schedule()

• set_schedule_remove() removes a schedule / un-schedules a variant

Beware, using set_schedule() currently uses the Posit Connect schedule API directly, and so can be a little clunky. Using the ⁠set_schedule_*()⁠ is generally recommended.

Value

An updated Schedule object

See Also

Other schedule functions: get_timezones(), get_variant_schedule()

connectapi documentation built on Feb. 26, 2026, 1:06 a.m.