Set Fan Mode

/thermostats/set_fan_mode

post

Sets the fan mode setting for a specified thermostat.

Authorizations

client_sessionpat_with_workspaceconsole_session_with_workspaceapi_key

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

device_idstring · uuidRequired

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

fan_modestring · enumOptionalDeprecatedPossible values:

fan_mode_settingstring · enumOptional

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

Possible values:

syncbooleanOptionalDefault: false

Responses

200

OK

application/json

400

Bad Request

401

Unauthorized

post

/thermostats/set_fan_mode

HTTPcURLJavaScriptPython

POST /thermostats/set_fan_mode HTTP/1.1
Host: connect.getseam.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 91

{
  "device_id": "123e4567-e89b-12d3-a456-426614174000",
  "fan_mode_setting": "auto",
  "sync": false
}

{
  "action_attempt": {
    "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000",
    "status": "pending",
    "result": null,
    "error": null,
    "action_type": "LOCK_DOOR"
  },
  "ok": true
}

Code Example

Curl

curl --request POST 'https://connect.getseam.com/thermostats/set_fan_mode' \
--header 'Authorization: Bearer ${API_KEY}' \
--header 'Content-Type: application/json' \
--header 'Seam-Workspace: 00000000-0000-0000-0000-000000000000' \
--data-raw '{
  "device_id": "11111111-1111-1111-1111-111111111111",
  "fan_mode_setting": "auto"
 }'

Parameters

device_id	type: string	ID of the Device of the thermostat
fan_mode	type: string	Fan mode of the thermostat. Possible values: on: The fan continuously operates, ensuring air circulation regardless of the heating or cooling demand. auto: The fan activates only when heating or cooling is on, making it a more energy-efficient choice.

Response

This section shows the JSON response returned by the API. Since each language encapsulates this response inside objects specific to that language and/or implementation, the actual type in your language might differ from what’s written here.

JSON format

JSON

{
  "action_attempt": {
    "status": "pending",
    "action_type": "SET_FAN_MODE",
    "action_attempt_id": "22222222-2222-2222-2222-222222222222",
    "result": null,
    "error": null
  },
  "ok": true
}