Set to Off Mode
Set a thermostat to "off" mode.
Sets a specified thermostat to "off" mode.
Authorizations
Body
device_idstring · uuidRequired
ID of the thermostat device that you want to set to off mode.
syncbooleanOptionalDefault:
false
Responses
200
OK
application/json
400
Bad Request
401
Unauthorized
post
POST /thermostats/off HTTP/1.1
Host: connect.getseam.com
Authorization: Bearer Client Session Token
Content-Type: application/json
Accept: */*
Content-Length: 65
{
"device_id": "123e4567-e89b-12d3-a456-426614174000",
"sync": false
}
{
"action_attempt": {
"action_attempt_id": "123e4567-e89b-12d3-a456-426614174000",
"status": "pending",
"result": null,
"error": null,
"action_type": "LOCK_DOOR"
},
"ok": true
}
Code Example
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
{
"action_attempt": {
"status": "pending",
"action_type": "SET_OFF",
"action_attempt_id": "22222222-2222-2222-2222-222222222222",
"result": null,
"error": null
},
"ok": true
}
Last updated
Was this helpful?