Update the refresh schedule

PATCH/api/v1/dashboards/{dashboard_id}/schedule

Patch the cadence or enabled state. Any cadence change — including re-enabling a disabled schedule — re-derives next_run_at from now, so a schedule that was paused for a long time does not fire immediately on resume.

Operation ID: update_dashboard_schedule_api_v1_dashboards__dashboard_id__schedule_patch·View as markdown·OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Path

dashboard_idstringrequired

Request body

Schema: DashboardRefreshScheduleUpdate

frequencystring
day_of_weekinteger
day_of_monthinteger
hour_utcinteger
timezonestring
is_enabledboolean

Responses

200Successful Response

Schema: SuccessEnvelope_DashboardRefreshScheduleResponse_

successboolean
messagestring
codestring
dataDashboardRefreshScheduleResponse

400Bad Request - Invalid input

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

404Not Found - Resource does not exist

422Validation Error

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError

5 fields

locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject

Code samples

PATCH/api/v1/dashboards/{dashboard_id}/schedule

bash

curl -X PATCH 'https://api.ondayzero.com/api/v1/dashboards/{dashboard_id}/schedule' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID' \
  -H 'Content-Type: application/json' \
  -d '{
  "frequency": "string",
  "day_of_week": 0,
  "day_of_month": 0,
  "hour_utc": 0,
  "timezone": "string",
  "is_enabled": false
}'