Set the Fan Mode Setting

Sets the fan mode setting for a specified thermostat.

POST /thermostats/set_fan_mode

JavaScript

Seam SDK

await seam.thermostats.setFanMode({ device_id: "363e657e-3b07-4670-a290-7fb1f32b8e33", fan_mode_setting: "auto", }); /* { "action_attempt_id": "2a3b4c5d-6e7f-8a9b-acbd-1e2f3a4b5c6d", "action_type": "SET_FAN_MODE", "error": null, "result": {}, "status": "success" } */

200

{
  "action_attempt": {
    "action_attempt_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "action_type": "SET_FAN_MODE",
    "result": {},
    "error": {
      "type": "<string>",
      "message": "<string>"
    }
  },
  "ok": true
}

Authorizations

client_sessionpat_with_workspaceconsole_session_with_workspaceapi_key

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

device_id · string<uuid> · required

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

fan_mode · enum<string> · deprecated

Available options: auto, on, circulate

fan_mode_setting · enum<string>

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

Available options: auto, on, circulate

sync · boolean · default: false

Response

200

application/json

OK

action_attempt · object · required

Tracks the progress of this operation. Poll using the action_attempt_id.

Show child attributes

ok · boolean · required