Set to Off Mode

• Request Parameters

• Response

Sets a specified thermostat to "off" mode.

JavaScript

Sets a specified thermostat to "off" mode.

Code

await seam.thermostats.off({
  device_id: "5d5c3b30-5fed-47a3-9df1-ed32f32589e5",
});

Output

{
  "action_attempt_id": "b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d",
  "action_type": "SET_HVAC_MODE",
  "error": null,
  "result": {},
  "status": "success"
}

cURL

Sets a specified thermostat to "off" mode.

Code

curl --include --request POST "https://connect.getseam.com/thermostats/off" \
  --header "Authorization: Bearer $SEAM_API_KEY" \
  --json @- <<EOF
{
  "device_id": "5d5c3b30-5fed-47a3-9df1-ed32f32589e5"
}
EOF

Output

{
  "action_attempt": {
    "action_attempt_id": "b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d",
    "action_type": "SET_HVAC_MODE",
    "error": null,
    "result": {},
    "status": "success"
  }
}

Python

Sets a specified thermostat to "off" mode.

Code

seam.thermostats.off(device_id="5d5c3b30-5fed-47a3-9df1-ed32f32589e5")

Output

ActionAttempt(
    action_attempt_id="b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d",
    action_type="SET_HVAC_MODE",
    error=None,
    result={},
    status="success",
)

Ruby

Sets a specified thermostat to "off" mode.

Code

seam.thermostats.off(device_id: "5d5c3b30-5fed-47a3-9df1-ed32f32589e5")

Output

{
  "action_attempt_id" => "b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d",
  "action_type" => "SET_HVAC_MODE",
  "error" => nil,
  "result" => {
  },
  "status" => "success",
}

PHP

Sets a specified thermostat to "off" mode.

Code

$seam->thermostats->off(device_id: "5d5c3b30-5fed-47a3-9df1-ed32f32589e5");

Output

[
    "action_attempt_id" => "b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d",
    "action_type" => "SET_HVAC_MODE",
    "error" => null,
    "result" => [],
    "status" => "success",
];

Seam CLI

Sets a specified thermostat to "off" mode.

Code

seam thermostats off --device_id "5d5c3b30-5fed-47a3-9df1-ed32f32589e5"

Output

{
  "action_attempt_id": "b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d",
  "action_type": "SET_HVAC_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 that you want to set to off mode.

---

Response

action_attempt

JSON

{
  "action_attempt_id": "b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d",
  "action_type": "SET_HVAC_MODE",
  "error": null,
  "result": {},
  "status": "success"
}