Thermostat Schedules

thermostat_schedule

Represents a thermostat schedule that activates a configured climate preset on a thermostat at a specified starting time and deactivates the climate preset at a specified ending time.

climate_preset_key

Format: String

Key of the climate preset to use for the thermostat schedule.

---

created_at

Format: Datetime

Date and time at which the thermostat schedule was created.

---

device_id

Format: UUID

ID of the desired thermostat device.

---

ends_at

Format: Datetime

Date and time at which the thermostat schedule ends, in ISO 8601 format.

---

errors

Format: List

Item format: Object

Errors associated with the thermostat schedule.

error_code Format: String

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.

message Format: String

Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

---

max_override_period_minutes

Format: Number

Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also Specifying Manual Override Permissions.

---

name

Format: String

User-friendly name to identify the thermostat schedule.

---

starts_at

Format: Datetime

Date and time at which the thermostat schedule starts, in ISO 8601 format.

---

thermostat_schedule_id

Format: UUID

ID of the thermostat schedule.

---

Endpoints

/thermostats/schedules/create

Creates a thermostat schedule for a specified thermostat.

/thermostats/schedules/delete

Deletes a thermostat schedule for a specified thermostat.

/thermostats/schedules/get

Returns a specified thermostat schedule.

/thermostats/schedules/list

Returns a list of all thermostat schedules for a specified thermostat.

/thermostats/schedules/update

Updates a specified thermostat schedule.