Set to Heat Mode

Set a thermostat to heating mode. To do so, you must include a heating set point in the payload, either in Celsius or Fahrenheit. For information about verifying the heating availability of the thermostat and validating the correct set points, see HVAC Mode Constraints and Set Point Constraints.

/thermostats/heat

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

Authorization

client_sessionpat_with_workspaceconsole_sessionapi_key

Body

application/json

device_id*string (uuid)

heating_set_point_celsiusnumber

heating_set_point_fahrenheitnumber

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/heat', {
    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/heat' \
--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",
  "heating_set_point_celsius": 25
 }'

Parameters

device_id	type: string	ID of the Device of the thermostat
heating_set_point_celsius	type: number Optional	Temperature the thermostat should heat to (in °C). You must set one of the heating_set_point parameters
heating_set_point_fahrenheit	type: number Optional	Temperature the thermostat should heat to (in °F). You must set one of the heating_set_point parameters

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_HEAT",
    "action_attempt_id": "22222222-2222-2222-2222-222222222222",
    "result": null,
    "error": null
  },
  "ok": true
}