Create a Climate Preset

• Request Parameters

• Response

• Examples

Creates a climate preset for a specified thermostat.

Signature

POST /thermostats/create_climate_preset ⇒ void

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.

---

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.

---

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

---

Examples

Create a climate preset

Specify the device_id of the desired thermostat, along with the desired settings for the climate preset, including manual_override_allowed.

JavaScript

Code

await seam.thermostats.createClimatePreset({
  device_id: "123e4567-e89b-12d3-a456-426614174000",
  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,
  manual_override_allowed: true,
});

Output

// void

Python

Code

seam.thermostats.create_climate_preset(
    device_id="123e4567-e89b-12d3-a456-426614174000",
    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,
    manual_override_allowed=true,
)

Output

None

Ruby

Code

seam.thermostats.create_climate_preset(
  device_id: "123e4567-e89b-12d3-a456-426614174000",
  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,
  manual_override_allowed: true,
)

Output

nil

PHP

Code

<?php
$seam->thermostats->create_climate_preset(
    device_id: "123e4567-e89b-12d3-a456-426614174000",
    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,
    manual_override_allowed: true
);

Output

null

Seam CLI

Code

seam thermostats create-climate-preset --device_id "123e4567-e89b-12d3-a456-426614174000" --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 --manual_override_allowed true

Output

{}

Go

Code

package main

import api "github.com/seamapi/go"

func main() {
	client.Thermostats.CreateClimatePreset(
		context.Background(),
		api.ThermostatsCreateClimatePresetRequest{
			DeviceId:               api.String("123e4567-e89b-12d3-a456-426614174000"),
			ClimatePresetKey:       api.String("occupied"),
			Name:                   api.String("Occupied"),
			FanModeSetting:         api.String("auto"),
			HvacModeSetting:        api.String("heat_cool"),
			CoolingSetPointCelsius: api.Float64(25),
			HeatingSetPointCelsius: api.Float64(20),
			ManualOverrideAllowed:  api.Bool(true),
		},
	)
}

Output

nil

cURL

Code

curl --include --request POST "https://connect.getseam.com/thermostats/create_climate_preset" \
  --header "Authorization: Bearer $SEAM_API_KEY" \
  --json @- <<EOF
{
  "device_id": "123e4567-e89b-12d3-a456-426614174000",
  "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,
  "manual_override_allowed": true
}
EOF

Output

{}