Live Exports

Update the schedule

Turn the export on or off and set its cadence — the only lifecycle switch (there is no pause/activate). A daily export also takes time_of_day, in timezone. Creates the schedule on first use; missing fields keep their current values. Requires a saved export.

patch/v1/live-export/live-exports/{id}/schedule

Request

  • Base URL: https://api.whalesync.com
  • URL: https://api.whalesync.com/v1/live-export/live-exports/{id}/schedule
  • Auth: HTTP bearer

Path parameters

idstring required
Example:lex_8f3kq0vz

Request body

enabledboolean

The on/off switch for the whole export. trigger still works while off.

cadence'every_10_minutes' | 'every_30_minutes' | 'hourly' | 'daily'

How often scheduled runs fire. Cadences above your plan are rejected — see allowed_cadences.

time_of_daystring

When a daily export runs: a whole hour in 24-hour time, in timezone. Only with the daily cadence. Left out, a daily schedule keeps its current time (midnight for a new one).

timezonestring

The IANA timezone time_of_day is in. UTC when never set.

Example request

{
  "time_of_day": "09:00",
  "timezone": "America/New_York"
}

Response

enabledboolean required

Whether the cadence is on. This is the on/off switch for the whole export.

cadence'every_10_minutes' | 'every_30_minutes' | 'hourly' | 'daily' | 'custom' required
time_of_daystring nullable required

When a daily export runs: a whole hour in 24-hour time, in timezone (UTC when no timezone is set). Null for the other cadences.

cronstring required

The exact schedule, as a cron expression. Read-only; set cadence and time_of_day instead.

timezonestring nullable required
next_run_atstring date-time nullable required

When the next scheduled run fires.

last_triggered_atstring date-time nullable required
allowed_cadencesstring[] required

The cadences your plan can set. Pick from these to avoid a plan_required error.

Example response

{
  "time_of_day": "09:00",
  "timezone": "America/New_York"
}

Changes

No recorded changes to this operation across all 1 revision of this API.