Start free trial

Create a refresh schedule

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

Schedule a recurring background refresh of this dashboard's widget sources. A dashboard may have at most one schedule — returns 400 if one already exists (PATCH it instead).

The refresh runs as you: at each run the scheduler re-resolves your current role and permissions and executes the widget sources under them. If your access to this business later lapses, the refresh fails closed rather than continuing as a standing grant.

Operation ID: create_dashboard_schedule_api_v1_dashboards__dashboard_id__schedule_post·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: DashboardRefreshScheduleRequest

frequencystring

One of: hourly, daily, weekly, monthly

day_of_weekinteger
day_of_monthinteger
hour_utcinteger
timezonestring
is_enabledboolean

Responses

201Successful 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