Update a Climate Preset

• Request Parameters

• Response

• Examples

Updates a specified climate preset for a specified thermostat.

Signature

PATCH /thermostats/update_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 to update a climate preset.

---

manual_override_allowed Boolean (Required)

Indicates whether a person at the thermostat can change the thermostat's settings. See Specifying Manual Override Permissions.

---

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.

---

name String

User-friendly name to identify the climate preset.

---

Response

void

---

Examples

Update a climate preset

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

JavaScript

Code

await seam.thermostats.updateClimatePreset({
  device_id: "123e4567-e89b-12d3-a456-426614174000",
  climate_preset_key: "occupied",
  cooling_set_point_celsius: 24,
  manual_override_allowed: true,
});

Output

// void

Python

Code

seam.thermostats.update_climate_preset(
    device_id="123e4567-e89b-12d3-a456-426614174000",
    climate_preset_key="occupied",
    cooling_set_point_celsius=24,
    manual_override_allowed=true,
)

Output

None

Ruby

Code

seam.thermostats.update_climate_preset(
  device_id: "123e4567-e89b-12d3-a456-426614174000",
  climate_preset_key: "occupied",
  cooling_set_point_celsius: 24,
  manual_override_allowed: true,
)

Output

nil

PHP

Code

<?php
$seam->thermostats->update_climate_preset(
    device_id: "123e4567-e89b-12d3-a456-426614174000",
    climate_preset_key: "occupied",
    cooling_set_point_celsius: 24,
    manual_override_allowed: true
);

Output

null

Seam CLI

Code

seam thermostats update-climate-preset --device_id "123e4567-e89b-12d3-a456-426614174000" --climate_preset_key "occupied" --cooling_set_point_celsius 24 --manual_override_allowed true

Output

{}

Go

Code

package main

import api "github.com/seamapi/go"

func main() {
	client.Thermostats.UpdateClimatePreset(
		context.Background(),
		api.ThermostatsUpdateClimatePresetRequest{
			DeviceId:               api.String("123e4567-e89b-12d3-a456-426614174000"),
			ClimatePresetKey:       api.String("occupied"),
			CoolingSetPointCelsius: api.Float64(24),
			ManualOverrideAllowed:  api.Bool(true),
		},
	)
}

Output

nil

cURL

Code

curl --include --request POST "https://connect.getseam.com/thermostats/update_climate_preset" \
  --header "Authorization: Bearer $SEAM_API_KEY" \
  --json @- <<EOF
{
  "device_id": "123e4567-e89b-12d3-a456-426614174000",
  "climate_preset_key": "occupied",
  "cooling_set_point_celsius": 24,
  "manual_override_allowed": true
}
EOF

Output

{}