Set Fan Mode

• Request Parameters

• Response

Sets the fan mode setting for a specified thermostat.

JavaScript

Sets the fan mode setting for a specified thermostat.

Code:

await seam.thermostats.setFanMode({
  device_id: "363e657e-3b07-4670-a290-7fb1f32b8e33",
  fan_mode_setting: "auto",
});

Output:

{
  "action_attempt_id": "2a3b4c5d-6e7f-8a9b-acbd-1e2f3a4b5c6d",
  "action_type": "SET_FAN_MODE",
  "error": null,
  "result": {},
  "status": "success"
}

cURL

Sets the fan mode setting for a specified thermostat.

Code:

curl --include --request POST "https://connect.getseam.com/thermostats/set_fan_mode" \
  --header "Authorization: Bearer $SEAM_API_KEY" \
  --json @- <<EOF
{
  "device_id": "363e657e-3b07-4670-a290-7fb1f32b8e33",
  "fan_mode_setting": "auto"
}
EOF

Output:

{
  "action_attempt": {
    "action_attempt_id": "2a3b4c5d-6e7f-8a9b-acbd-1e2f3a4b5c6d",
    "action_type": "SET_FAN_MODE",
    "error": null,
    "result": {},
    "status": "success"
  }
}

Python

Sets the fan mode setting for a specified thermostat.

Code:

seam.thermostats.set_fan_mode(
    device_id="363e657e-3b07-4670-a290-7fb1f32b8e33", fan_mode_setting="auto"
)

Output:

ActionAttempt(
    action_attempt_id="2a3b4c5d-6e7f-8a9b-acbd-1e2f3a4b5c6d",
    action_type="SET_FAN_MODE",
    error=None,
    result={},
    status="success",
)

Ruby

Sets the fan mode setting for a specified thermostat.

Code:

seam.thermostats.set_fan_mode(
  device_id: "363e657e-3b07-4670-a290-7fb1f32b8e33",
  fan_mode_setting: "auto",
)

Output:

{
  "action_attempt_id" => "2a3b4c5d-6e7f-8a9b-acbd-1e2f3a4b5c6d",
  "action_type" => "SET_FAN_MODE",
  "error" => nil,
  "result" => {
  },
  "status" => "success",
}

PHP

Sets the fan mode setting for a specified thermostat.

Code:

$seam->thermostats->set_fan_mode(
    device_id: "363e657e-3b07-4670-a290-7fb1f32b8e33",
    fan_mode_setting: "auto"
);

Output:

[
    "action_attempt_id" => "2a3b4c5d-6e7f-8a9b-acbd-1e2f3a4b5c6d",
    "action_type" => "SET_FAN_MODE",
    "error" => null,
    "result" => [],
    "status" => "success",
];

Seam CLI

Sets the fan mode setting for a specified thermostat.

Code:

seam thermostats set-fan-mode --device_id "363e657e-3b07-4670-a290-7fb1f32b8e33" --fan_mode_setting "auto"

Output:

{
  "action_attempt_id": "2a3b4c5d-6e7f-8a9b-acbd-1e2f3a4b5c6d",
  "action_type": "SET_FAN_MODE",
  "error": null,
  "result": {},
  "status": "success"
}

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 String (Required)

ID of the thermostat device for which you want to set the fan mode.

---

fan_mode String

---

fan_mode_setting String

Fan mode setting that you want to set for the thermostat.

---

Response

action_attempt

JSON

{
  "action_attempt_id": "2a3b4c5d-6e7f-8a9b-acbd-1e2f3a4b5c6d",
  "action_type": "SET_FAN_MODE",
  "error": null,
  "result": {},
  "status": "success"
}