Set Fan Mode

/thermostats/set_fan_mode

POSThttps://connect.getseam.com/thermostats/set_fan_mode

Authorization

client_sessionpat_with_workspaceconsole_sessionapi_key

Body

application/json

device_id*string (uuid)

fan_modeenum

autoon

fan_mode_settingenum

autoon

syncboolean

Response

200400401

OK

Body

application/json

action_attempt*action_attempt (one of)

successpendingerror

ok*boolean

Request

JavaScriptCurl

const response = await fetch('https://connect.getseam.com/thermostats/set_fan_mode', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer Client Session Token",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "device_id": "123e4567-e89b-12d3-a456-426614174000"
    }),
});
const data = await response.json();

Response

{
  "action_attempt": {
    "status": "success",
    "action_type": "text",
    "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000",
    "error": "text"
  },
  "ok": false
}

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: 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
}