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

> Create a refresh schedule

- **Tag:** dashboards
- **Operation ID:** `create_dashboard_schedule_api_v1_dashboards__dashboard_id__schedule_post`

## Description

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.

## Authentication

Bearer token in `Authorization` header.
Required header: `x-business-id: <business uuid>`.

## Parameters

- `dashboard_id` (path, string, required)

## Request body

Schema: `DashboardRefreshScheduleRequest`

- `frequency` (string) (one of: hourly, daily, weekly, monthly)
- `day_of_week` (integer)
- `day_of_month` (integer)
- `hour_utc` (integer)
- `timezone` (string)
- `is_enabled` (boolean)

## Responses

### 201 — Successful Response

Schema: `SuccessEnvelope_DashboardRefreshScheduleResponse_`

- `success` (boolean)
- `message` (string)
- `code` (string)
- `data` (DashboardRefreshScheduleResponse)

### 400 — Bad Request - Invalid input

### 401 — Unauthorized - Authentication required

### 403 — Forbidden - Insufficient permissions

### 404 — Not Found - Resource does not exist

### 422 — Validation Error

Schema: `HTTPValidationError`

- `detail` (array · ValidationError) → `ValidationError`
  - `loc` (array · string | integer · required)
  - `msg` (string · required)
  - `type` (string · required)
  - `input` (object)
  - `ctx` (object)

## Code samples

### cURL

```bash
curl -X POST '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": "hourly",
  "day_of_week": 0,
  "day_of_month": 0,
  "hour_utc": 0,
  "timezone": "string",
  "is_enabled": false
}'
```

### JavaScript

```javascript
const response = await fetch('https://api.ondayzero.com/api/v1/dashboards/{dashboard_id}/schedule', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer dz_your_token',
    'x-business-id': 'YOUR_BUSINESS_ID',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "frequency": "hourly",
  "day_of_week": 0,
  "day_of_month": 0,
  "hour_utc": 0,
  "timezone": "string",
  "is_enabled": false
}),
});
const data = await response.json();
```

### Python

```python
import httpx

headers = {
    "Authorization": "Bearer dz_your_token",
    "x-business-id": "YOUR_BUSINESS_ID",
}

payload = {
  "frequency": "hourly",
  "day_of_week": 0,
  "day_of_month": 0,
  "hour_utc": 0,
  "timezone": "string",
  "is_enabled": false
}

response = httpx.post("https://api.ondayzero.com/api/v1/dashboards/{dashboard_id}/schedule", headers=headers, json=payload)
data = response.json()
```

## See also

- HTML version: https://www.ondayzero.com/docs/reference/dashboards/create-dashboard-schedule
- OpenAPI slice: https://www.ondayzero.com/docs/reference/dashboards/create-dashboard-schedule/openapi.json
- Other endpoints in **dashboards**: https://www.ondayzero.com/docs/reference/dashboards