Skip to main content
POST
Creates a climate preset for a specified thermostat.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
climate_preset_key
string
required

Unique key to identify the climate preset.

device_id
string<uuid>
required

ID of the thermostat device for which you want create a climate preset.

climate_preset_mode
enum<string>

The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.

Available options:
home,
away,
wake,
sleep,
occupied,
unoccupied
cooling_set_point_celsius
number

Temperature to which the thermostat should cool (in °C). See also Set Points.

cooling_set_point_fahrenheit
number

Temperature to which the thermostat should cool (in °F). See also Set Points.

ecobee_metadata
object

Metadata specific to the Ecobee climate, if applicable.

fan_mode_setting
enum<string>

Desired fan mode setting, such as on, auto, or circulate.

Available options:
auto,
on,
circulate
heating_set_point_celsius
number

Temperature to which the thermostat should heat (in °C). See also Set Points.

heating_set_point_fahrenheit
number

Temperature to which the thermostat should heat (in °F). See also Set Points.

hvac_mode_setting
enum<string>

Desired HVAC mode setting, such as heat, cool, heat_cool, or off.

Available options:
off,
heat,
cool,
heat_cool,
eco
name
string | null

User-friendly name to identify the climate preset.

Response

200

OK