exports

Edit an export schedule.

Partial update (merge patch). Requires dashboard:write. Editable fields: title, cron or preset (not both), timezone, format, enabled. When cron or timezone changes, next_run_at is recomputed atomically. Email and is_external on recipients are immutable — change by delete + re-add.

A timezone that cannot be resolved to an IANA zone is a 422 (DVT-4321), not a 400; the failing value is echoed in a timezone extension field. A blank timezone, or "Local", normalizes to UTC rather than being rejected.

patch/v1/dashboards/{id}/export-schedules/{sid}

Request

  • Base URL: http://localhost:8080
  • URL: http://localhost:8080/v1/dashboards/{id}/export-schedules/{sid}
  • Auth: one of:
    • API key in cookie dvt_session
    • HTTP bearer

Request body

titlestring nullable
cronstring
timezonestring

IANA timezone name. A blank value, or "Local", normalizes to "UTC" AND recomputes nextRunAt — it does not mean "leave the zone alone", which is what omitting the field does. Any other name that cannot be resolved is a 422.

format'pdf' | 'png' | 'xlsx' | 'csv'

Changing to, or editing a schedule that is, xlsx/csv requires data:query and data:export (403 without both; the free plan has neither; a pure enabled: false is exempt). xlsx/csv are email-only and never stored: the request is a 400 if the schedule has channel destinations or the request body carries a non-empty destinations field (an undeclared field, ignored for pdf/png).

panelIdstring nullable

When set to a string, updates the panel scope; the effective format (this PATCH's format or, if absent, the existing one) must be png, or xlsx/csv with a table panel (sheet and other panel types return 400; xlsx/csv always need a panel scope). When set to null, clears the panel scope (whole-dashboard). Absent means no change.

pageIdstring nullable

When set to a string, updates the page scope (page slug; must exist in the dashboard's current multi-page spec). When set to null, clears the page scope (whole-dashboard). Absent means no change. The effective post-patch row may not carry both a panel and a page scope (400).

enabledboolean

Response

Updated schedule.

Changes

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