Create a Climate Preset

• Request Parameters

• Response

Creates a climate preset for a specified thermostat.

JavaScript

Creates a climate preset for a specified thermostat.

Code:

await seam.thermostats.createClimatePreset({
  device_id: "ba9b816d-c255-46b9-a16d-971e6f535dd3",
  manual_override_allowed: true,
  climate_preset_key: "Occupied",
  name: "Occupied",
  fan_mode_setting: "auto",
  hvac_mode_setting: "heat_cool",
  cooling_set_point_celsius: 25,
  heating_set_point_celsius: 20,
});

Output:

// void

cURL

Creates a climate preset for a specified thermostat.

Code:

curl --include --request POST "https://connect.getseam.com/thermostats/create_climate_preset" \
  --header "Authorization: Bearer $SEAM_API_KEY" \
  --json @- <<EOF
{
  "device_id": "ba9b816d-c255-46b9-a16d-971e6f535dd3",
  "manual_override_allowed": true,
  "climate_preset_key": "Occupied",
  "name": "Occupied",
  "fan_mode_setting": "auto",
  "hvac_mode_setting": "heat_cool",
  "cooling_set_point_celsius": 25,
  "heating_set_point_celsius": 20
}
EOF

Output:

{}

Python

Creates a climate preset for a specified thermostat.

Code:

seam.thermostats.create_climate_preset(
    device_id="ba9b816d-c255-46b9-a16d-971e6f535dd3",
    manual_override_allowed=true,
    climate_preset_key="Occupied",
    name="Occupied",
    fan_mode_setting="auto",
    hvac_mode_setting="heat_cool",
    cooling_set_point_celsius=25,
    heating_set_point_celsius=20,
)

Output:

None

Ruby

Creates a climate preset for a specified thermostat.

Code:

seam.thermostats.create_climate_preset(
  device_id: "ba9b816d-c255-46b9-a16d-971e6f535dd3",
  manual_override_allowed: true,
  climate_preset_key: "Occupied",
  name: "Occupied",
  fan_mode_setting: "auto",
  hvac_mode_setting: "heat_cool",
  cooling_set_point_celsius: 25,
  heating_set_point_celsius: 20,
)

Output:

nil

PHP

Creates a climate preset for a specified thermostat.

Code:

$seam->thermostats->create_climate_preset(
    device_id: "ba9b816d-c255-46b9-a16d-971e6f535dd3",
    manual_override_allowed: true,
    climate_preset_key: "Occupied",
    name: "Occupied",
    fan_mode_setting: "auto",
    hvac_mode_setting: "heat_cool",
    cooling_set_point_celsius: 25,
    heating_set_point_celsius: 20
);

Output:

Seam CLI

Creates a climate preset for a specified thermostat.

Code:

seam thermostats create-climate-preset --device_id "ba9b816d-c255-46b9-a16d-971e6f535dd3" --manual_override_allowed true --climate_preset_key "Occupied" --name "Occupied" --fan_mode_setting "auto" --hvac_mode_setting "heat_cool" --cooling_set_point_celsius 25 --heating_set_point_celsius 20

Output:

{}

Authentication Methods

• API key

• Client session token

• Personal access token Must also include the seam-workspace header in the request.

To learn more, see Authentication.

Request Parameters

climate_preset_key String (Required)

Unique key to identify the climate preset.

---

device_id String (Required)

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

---

climate_preset_mode String

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

---

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.

climate_ref String

Reference to the Ecobee climate, if applicable.

---

is_optimized Boolean

Indicates if the climate preset is optimized by Ecobee.

---

owner Enum

Indicates whether the climate preset is owned by the user or the system.

Enum values:

• user

• system

---

fan_mode_setting String

Desired fan mode setting, such as on, auto, or 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 String

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

---

manual_override_allowed Boolean

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

---

name String

User-friendly name to identify the climate preset.

---

Response

void