Update a Climate Setting Schedule

/thermostats/climate_setting_schedules/update

POSThttps://connect.getseam.com/thermostats/climate_setting_schedules/update
Authorization
Body
climate_setting_schedule_id*string (uuid)
schedule_typeenum
time_bound
namestring
schedule_starts_atstring
schedule_ends_atstring
automatic_heating_enabledboolean
automatic_cooling_enabledboolean
hvac_mode_settingenum
offheatcoolheat_cool
cooling_set_point_celsiusnumber
heating_set_point_celsiusnumber
cooling_set_point_fahrenheitnumber
heating_set_point_fahrenheitnumber
manual_override_allowedboolean
Response

OK

Body
climate_setting_schedule*climate_setting_schedule (object)
ok*boolean
Request
const response = await fetch('https://connect.getseam.com/thermostats/climate_setting_schedules/update', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer Client Session Token",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "climate_setting_schedule_id": "123e4567-e89b-12d3-a456-426614174000"
    }),
});
const data = await response.json();
Response
{
  "climate_setting_schedule": {
    "climate_setting_schedule_id": "123e4567-e89b-12d3-a456-426614174000",
    "schedule_type": "time_bound",
    "device_id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "schedule_starts_at": "text",
    "schedule_ends_at": "text",
    "created_at": "2024-05-21T03:59:31.278Z",
    "automatic_heating_enabled": false,
    "automatic_cooling_enabled": false,
    "hvac_mode_setting": "off",
    "cooling_set_point_celsius": 0,
    "heating_set_point_celsius": 0,
    "cooling_set_point_fahrenheit": 0,
    "heating_set_point_fahrenheit": 0,
    "manual_override_allowed": false
  },
  "ok": false
}

Code Examples

seam.climate_setting_schedules.update(
    "123e4567-e89b-12d3-a456-426614174001",
    automatic_heating_enabled=False,
    heating_set_point_fahrenheit=null,
)

# ClimateSettingSchedule:
#    climate_setting_schedule_id: 123e4567-e89b-12d3-a456-426614174000
#    device_id: 123e4567-e89b-12d3-a456-426614174001
#    name: Guest Stay #1234  
#    schedule_starts_at: 2022-07-01T10:40:00Z    
#    schedule_ends_at: 2022-07-10T10:40:00Z     
#    created_at: 2022-07-06T23:26:42.223Z      
#    is_set_on_device: False
#    automatic_cooling_enabled: True  
#    hvac_mode_setting: cool
#    cooling_set_point_fahrenheit: 75 
#    manual_override_allowed: False

Parameters

name

type: string Optional

Name of Climate Setting Schedule

schedule_starts_at

type: ISO8601 string Optional

Date time when the Climate Setting Schedule should be programmed

schedule_ends_at

type: ISO8601 string Optional

Date time when the Climate Setting Schedule should be removed

automatic_heating_enabled

type: boolean Optional

When enabled, your system will only heat your home. Your thermostat will start heating to maintain the heating set point temperature selected.

automatic_cooling_enabled

type: string Optional

When enabled, your system will only cooling your home. Your thermostat will start cooling to maintain the cooling set point temperature selected.

heating_set_point_fahrenheit

type: number Optional

When automatic_heating_enabled is set, a heating set point must be provided. The thermostat will start heating to maintain this temperature set point.

cooling_set_point_fahrenheit

type: number Optional

When automatic_cooling_enabled is set, a cooling set point must be provided. The thermostat will start cooling to maintain this temperature set point.

manual_override_allowed

type: boolean Optional

Whether another user can use the thermostat or API to override this climate setting

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": "UPDATE_CLIMATE_SETTING_SCHEDULE",
    "action_attempt_id": "bbb8a07d-a91d-4564-b002-8172f7cdadc4",
    "result": null,
    "error": null
  },
  "ok": true
}

Last updated

Logo

Β© Seam Labs, Inc. All rights reserved.