A maintenance window that defines a scheduled time period during which case-related notifications and automation rules are suppressed. Each maintenance window applies to cases matching a specified query.
attributes [required]
object
Attributes of a maintenance window, including its schedule and the query that determines which cases are affected.
created_by
string
The UUID of the user who created this maintenance window. Read-only.
end_at [required]
date-time
The ISO 8601 timestamp when the maintenance window ends and normal notification behavior resumes.
name [required]
string
A human-readable name for the maintenance window (for example, Database migration - Dec 15).
query [required]
string
A case search query that determines which cases are affected during the maintenance window. Uses the same syntax as the Case Management search bar.
start_at [required]
date-time
The ISO 8601 timestamp when the maintenance window begins and notifications start being suppressed.
updated_by
string
The UUID of the user who last modified this maintenance window. Read-only.
id [required]
string
The maintenance window's identifier.
type [required]
enum
JSON:API resource type for maintenance windows.
Allowed enum values: maintenance_window