Set to Off Mode

Sets a specified thermostat to “off” mode.

POST /thermostats/off

JavaScript

Seam SDK

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

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

200

{
  "action_attempt": {
    "action_attempt_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "action_type": "SET_HVAC_MODE",
    "status": "pending",
    "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 that you want to set to off mode.

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