Set to Off Mode

Set a thermostat to "off" mode.

/thermostats/off

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

Authorization

client_sessionpat_with_workspaceconsole_sessionapi_key

Body

application/json

device_id*string (uuid)

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/off', {
    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/off' \
--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"
 }'

Parameters

device_id

type: string

ID of the Device of the thermostat

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