---
title: "Update the schedule"
method: PATCH
path: "/v1/live-export/live-exports/{id}/schedule"
tags: ["Live Exports"]
---

# Update the schedule

`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

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.

## Path parameters

- `id` string, required

## Request body

- LiveExportScheduleUpdate
  - `enabled` boolean: 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_day` string: 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).
  - `timezone` string: The IANA timezone `time_of_day` is in. UTC when never set.

## Response `200`

- LiveExportScheduleDetail
  - `enabled` boolean, 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_day` string, 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.
  - `cron` string, required: The exact schedule, as a cron expression. Read-only; set `cadence` and `time_of_day` instead.
  - `timezone` string, nullable, required
  - `next_run_at` string, date-time, nullable, required: When the next scheduled run fires.
  - `last_triggered_at` string, date-time, nullable, required
  - `allowed_cadences` string[], required: The cadences your plan can set. Pick from these to avoid a `plan_required` error.

## Other responses

- `401`: The API key is missing, invalid, or revoked (`missing_api_key`, `invalid_api_key`). Carries a `required_action` linking a person to key creation, naming the smallest scope this endpoint needs.
- `403`: The key's scope does not allow this call (`insufficient_scope` on a mutation with a `read` key).
- `404`: No live export with that id, or it belongs to someone else.
- `429`: Rate limit exceeded. Wait for `Retry-After` seconds.

---

[API](https://skmtc.dev/whalesync/apis/whalesync-api.md) · [All operations](https://skmtc.dev/whalesync/apis/whalesync-api/llms.txt) · [OpenAPI document](https://skmtc.dev/whalesync/apis/whalesync-api/revisions/5131522b325a?raw)