Draft a maintenance window
draft_maintenanceUse this when the user plans work on a site (a deploy, an upgrade, a migration) and wants it marked as maintenance, once or on a schedule, optionally telling status page subscribers. Returns the window in the user's time zone (and the next occurrences of a recurring one), the status pages it shows on and how many subscribers would be emailed, with a draft id. Saves the draft and schedules nothing. Not for an outage that is already happening: use draft_incident_post.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| days | No | For weekly or biweekly: the weekdays, such as saturday. Default: the weekday of when's date. | |
| site | Yes | The site: its id, name or part of its URL. | |
| when | Yes | When it starts: a date and time such as 2026-11-02 02:00 (read in timezone), or RFC 3339. For a recurring window, the time of day such as 02:00. | |
| title | Yes | What the work is, as subscribers will read it. | |
| weekday | No | For monthly on a weekday: the day. | |
| timezone | No | The IANA time zone the time is in, such as Europe/London. Default: the user's own zone. | |
| recurrence | No | none (once, the default), daily, weekly, biweekly or monthly. | |
| description | No | Optional details shown with the window. | |
| day_of_month | No | For monthly on a date: the day, 1 to 31. | |
| week_of_month | No | For monthly on a weekday: which one. | |
| duration_minutes | Yes | How long it lasts, 1 to 720 minutes (12 hours). | |
| notify_subscribers | No | Email the status page subscribers about it. Only when the user asks; default false. |