Skip to main content
POST
Creates a new thermostat schedule for a specified thermostat.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
climate_preset_key
string
required

Key of the climate preset to use for the new thermostat schedule.

device_id
string
required

ID of the thermostat device for which you want to create a schedule.

ends_at
string
required

Date and time at which the new thermostat schedule ends, in ISO 8601 format.

starts_at
string
required

Date and time at which the new thermostat schedule starts, in ISO 8601 format.

is_override_allowed
boolean

Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the new schedule is active. See also Specifying Manual Override Permissions.

max_override_period_minutes
integer | null

Number of minutes for which a person at the thermostat or using the API can change the thermostat's settings after the activation of the scheduled climate preset. See also Specifying Manual Override Permissions.

name
string

Name of the thermostat schedule.

Response

200 - application/json

OK

thermostat_schedule
object
required

Represents a thermostat schedule that activates a configured climate preset on a thermostat at a specified starting time and deactivates the climate preset at a specified ending time. See the thermostat_schedule object.