Activate a Climate Preset

Activates a specified climate preset for a specified thermostat.

Specify the device_id of the desired thermostat and the climate_preset_key of the desired climate preset.

Code

await seam.thermostats.activateClimatePreset({
  device_id: "123e4567-e89b-12d3-a456-426614174000",
  climate_preset_key: "occupied",
});

Output

{
  "action_attempt_id": "05de2295-d1dc-4748-aae3-9931658bde20",
  "status": "pending",
  "action_type": "ACTIVATE_CLIMATE_PRESET"
}
Authentication Methods
  • API key

  • 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)

Climate preset key of the climate preset that you want to activate.


device_id String (Required)

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


Response

action_attempt


Examples

Last updated

Was this helpful?

Revision created

ci: Generate docs