Set Fan Mode

POST /thermostats/set_fan_mode ⇒ { action_attempt }

Sets the fan mode setting for a specified thermostat.

JavaScript

Request

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

Response

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

Python

Ruby

PHP

Seam CLI

Go

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

---

fan_mode

Type: string Required: No

---

fan_mode_setting

Type: string Required: No

Desired fan mode setting for the thermostat.

---

Return Type

action_attempt

SET_FAN_MODE

Setting fan 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

---