Set to Off Mode
POST /thermostats/off ⇒ { action_attempt }Sets a specified thermostat to "off" mode.
Request
await seam.thermostats.off({
device_id: "123e4567-e89b-12d3-a456-426614174000",
});Response
{
"action_attempt_id": "123e4567-e89b-12d3-a456-426614174000",
"status": "pending",
"action_type": "SET_THERMOSTAT_OFF"
}Request
seam.thermostats.off(device_id="123e4567-e89b-12d3-a456-426614174000")Response
ActionAttempt(
action_attempt_id="123e4567-e89b-12d3-a456-426614174000",
status="pending",
action_type="SET_THERMOSTAT_OFF",
)Request
seam.thermostats.off(device_id: "123e4567-e89b-12d3-a456-426614174000")Response
{
"action_attempt_id" => "123e4567-e89b-12d3-a456-426614174000",
"status" => "pending",
"action_type" => "SET_THERMOSTAT_OFF",
}Request
<?php
$seam->thermostats->off(device_id: "123e4567-e89b-12d3-a456-426614174000");Response
<?php
[
"action_attempt_id" => "123e4567-e89b-12d3-a456-426614174000",
"status" => "pending",
"action_type" => "SET_THERMOSTAT_OFF",
];Request
seam thermostats off --device_id "123e4567-e89b-12d3-a456-426614174000"Response
{
"action_attempt_id": "123e4567-e89b-12d3-a456-426614174000",
"status": "pending",
"action_type": "SET_THERMOSTAT_OFF"
}Request
package main
import api "github.com/seamapi/go"
func main() {
client.Thermostats.Off(
context.Background(),
api.ThermostatsOffRequest{
DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"),
},
)
}Response
api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Status: "pending", ActionType: "SET_THERMOSTAT_OFF"}Authentication Methods
API key
Client session token
Personal access token Must also include the
seam-workspaceheader in the request.
Request Parameters
device_id
device_idType: string
Required: Yes
ID of the desired thermostat device.
Return Type
SET_HVAC_MODE
SET_HVAC_MODESetting HVAC mode.
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?

