thermostats

Update Weekly Schedule

Updates the weekly schedule for the thermostat with the given comfort ref. The time range includes the firstTimeBlock and goes up to but does not include the lastTimeBlock. Special case: When lastTimeBlock is set to '23:59', it represents the end of day (midnight) and includes the final 30-minute time slot (23:30-00:00), allowing a full day schedule from '00:00' to '23:59'. The schedule uses 48 time slots per day (each 30 minutes), where index 0 = 00:00-00:30 and index 47 = 23:30-00:00.

patch/thermostats/{thermostatId}/schedule

Request

  • Base URL
    https://api.sb.ecobee.com/api/v2
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://api.sb.ecobee.com/api/v2/token scopes: read:thermostat, write:thermostat

Request body

daysstring[]
firstTimeBlockstring

HH:MM representation of a time block in the schedule. Must be in half-hour intervals (minutes = 00 or 30), OR the special value '23:59' to represent end of day (midnight). Valid examples: '00:00', '00:30', '12:00', '23:00', '23:30', '23:59'. Invalid examples: '12:15', '23:58', '24:00'. When used as lastTimeBlock, '23:59' includes the final time slot (23:30-00:00).

lastTimeBlockstring

HH:MM representation of a time block in the schedule. Must be in half-hour intervals (minutes = 00 or 30), OR the special value '23:59' to represent end of day (midnight). Valid examples: '00:00', '00:30', '12:00', '23:00', '23:30', '23:59'. Invalid examples: '12:15', '23:58', '24:00'. When used as lastTimeBlock, '23:59' includes the final time slot (23:30-00:00).

comfortSettingRefstring

Comfort setting to set the schedule with

Example request

{
  "days": [
    "monday"
  ],
  "firstTimeBlock": "00:00",
  "lastTimeBlock": "23:59",
  "comfortSettingRef": "home"
}

Response

Success

status'success'

Example response

{
  "data": {
    "days": [
      "monday"
    ],
    "firstTimeBlock": "00:00",
    "lastTimeBlock": "23:59",
    "comfortSettingRef": "home"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.