Activate a Climate Preset
POST /thermostats/activate_climate_preset ⇒ { action_attempt }Activates a specified climate preset for a specified thermostat.
Request
await seam.thermostats.activateClimatePreset({
device_id: "123e4567-e89b-12d3-a456-426614174000",
climate_preset_key: "occupied",
});Response
{
"action_attempt_id": "05de2295-d1dc-4748-aae3-9931658bde20",
"status": "pending",
"action_type": "ACTIVATE_CLIMATE_PRESET"
}Request
seam.thermostats.activate_climate_preset(
device_id="123e4567-e89b-12d3-a456-426614174000", climate_preset_key="occupied"
)Response
ActionAttempt(
action_attempt_id="05de2295-d1dc-4748-aae3-9931658bde20",
status="pending",
action_type="ACTIVATE_CLIMATE_PRESET",
)Request
seam.thermostats.activate_climate_preset(
device_id: "123e4567-e89b-12d3-a456-426614174000",
climate_preset_key: "occupied",
)Response
{
"action_attempt_id" => "05de2295-d1dc-4748-aae3-9931658bde20",
"status" => "pending",
"action_type" => "ACTIVATE_CLIMATE_PRESET",
}Request
<?php
$seam->thermostats->activate_climate_preset(
device_id: "123e4567-e89b-12d3-a456-426614174000",
climate_preset_key: "occupied"
);Response
<?php
[
"action_attempt_id" => "05de2295-d1dc-4748-aae3-9931658bde20",
"status" => "pending",
"action_type" => "ACTIVATE_CLIMATE_PRESET",
];Request
seam thermostats activate-climate-preset --device_id "123e4567-e89b-12d3-a456-426614174000" --climate_preset_key "occupied"Response
{
"action_attempt_id": "05de2295-d1dc-4748-aae3-9931658bde20",
"status": "pending",
"action_type": "ACTIVATE_CLIMATE_PRESET"
}Request
package main
import api "github.com/seamapi/go"
func main() {
client.Thermostats.ActivateClimatePreset(
context.Background(),
api.ThermostatsActivateClimatePresetRequest{
DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"),
ClimatePresetKey: api.String("occupied"),
},
)
}Response
api.ActionAttempt{ActionAttemptId: "05de2295-d1dc-4748-aae3-9931658bde20", Status: "pending", ActionType: "ACTIVATE_CLIMATE_PRESET"}Authentication Methods
API key
Personal access token Must also include the
seam-workspaceheader in the request.
Request Parameters
climate_preset_key
climate_preset_keyType: string
Required: Yes
Climate preset key of the desired climate preset.
device_id
device_idType: string
Required: Yes
ID of the desired thermostat device.
Return Type
ACTIVATE_CLIMATE_PRESET
ACTIVATE_CLIMATE_PRESETActivating climate preset.
action_attempt_id
action_attempt_idFormat: UUID
The ID of the action attempt.
action_type
action_typeFormat: String
error
errorFormat: Object
result
resultFormat: Object
This object has no properties.
status
statusFormat: Enum
Possible enum values:
successpendingerror
Last updated
Was this helpful?

