Set to Off Mode

POST /thermostats/off ⇒ { action_attempt }

Sets a specified thermostat to "off" mode.

JavaScript

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"
}

Python

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",
)

Ruby

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",
}

PHP

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",
];

Seam CLI

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"
}

Go

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-workspace header in the request.

Request Parameters

device_id

Type: string Required: Yes

ID of the desired thermostat device.

---

Return Type

action_attempt

SET_HVAC_MODE

Setting HVAC mode.

action_attempt_id

Format: UUID

The ID of the action attempt.

---

action_type

Format: String

---

error

Format: Object

message Format: String

type Format: String

---

result

Format: Object

This object has no properties.

---

status

Format: Enum

Possible enum values:

• success

• pending

• error

---