Set to Off Mode

• Request Parameters

• Response

• Examples

Sets a specified thermostat to "off" mode.

Signature

POST /thermostats/off ⇒ { action_attempt }

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

device_id (Required)

ID of the desired thermostat device.

---

Response

action_attempt

SET_HVAC_MODE

JSON

{
  action_attempt_id: [example value],
  action_type: [example value],
  error: [example value],
  result: [example value],
  status: [example value]
}

---

Examples

Set to off mode

Specify the device_id of the thermostat that you want to set to off mode.

JavaScript

Code

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

Output

{
  "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "pending",
  "action_type": "SET_THERMOSTAT_OFF"
}

Python

Code

seam.thermostats.off(device_id="123e4567-e89b-12d3-a456-426614174000")

Output

ActionAttempt(
    action_attempt_id="123e4567-e89b-12d3-a456-426614174000",
    status="pending",
    action_type="SET_THERMOSTAT_OFF",
)

Ruby

Code

seam.thermostats.off(device_id: "123e4567-e89b-12d3-a456-426614174000")

Output

{
  "action_attempt_id" => "123e4567-e89b-12d3-a456-426614174000",
  "status" => "pending",
  "action_type" => "SET_THERMOSTAT_OFF",
}

PHP

Code

<?php
$seam->thermostats->off(device_id: "123e4567-e89b-12d3-a456-426614174000");

Output

<?php
[
    "action_attempt_id" => "123e4567-e89b-12d3-a456-426614174000",
    "status" => "pending",
    "action_type" => "SET_THERMOSTAT_OFF",
];

Seam CLI

Code

seam thermostats off --device_id "123e4567-e89b-12d3-a456-426614174000"

Output

{
  "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "pending",
  "action_type": "SET_THERMOSTAT_OFF"
}

Go

Code

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

Output

api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Status: "pending", ActionType: "SET_THERMOSTAT_OFF"}