Skip to main content
POST

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>
Available options:
home,
away,
wake,
sleep,
occupied,
unoccupied
​
cooling_set_point_celsius
number<float>

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

​
cooling_set_point_fahrenheit
number<float>

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

​
ecobee_metadata
object
​
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<float>

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

​
heating_set_point_fahrenheit
number<float>

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
​
manual_override_allowed
boolean
default:true
deprecated

Deprecated. Use 'thermostat_schedule.is_override_allowed'

Indicates whether a person at the thermostat or using the API can change the thermostat's settings.

​
name
string | null

User-friendly name to identify the climate preset.

Response

OK

The response is of type object.