Pauses an active schedule so that it stops generating new occurrences. Existing occurrences are not affected. Optionally pause only the sub-schedules for specific sites or assets by setting sites or assets. The schedule can be resumed later via the Resume schedule endpoint.
Pauses an active schedule so that it stops generating new occurrences. Existing occurrences are not affected. The schedule can be resumed later via Resume a schedule. However, you cannot pause or resume a schedule that has already ended.
Pause sub-schedules
By default, the whole schedule pauses. To pause only part of a schedule, include a target in the request body.
| Option | Description |
|---|---|
| No target | Pauses the schedule and all of its sub-schedules. |
sites | Pauses only the sub-schedules for the given sites. Accepts 1-10,000 site IDs. |
assets | Pauses only the sub-schedules for the given assets. Accepts 1-10,000 asset IDs. |
Set only one of sites or assets. The option must match the schedule's own target type.
If you pause the last active sub-schedule, the schedule itself also pauses.
Requirements
- Mitti Premium Plan or Enterprise Plan
- "Schedules: Manage" permission, or "Schedules: Create" permission with schedule admin access
- Full seat