Skip to main content
POST

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
thermostat_schedule_id
string<uuid>
required

ID of the thermostat schedule that you want to update.

​
climate_preset_key
string

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

​
ends_at
string

Date and time at which the thermostat schedule ends, 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 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.

Required range: x > 0
​
name
string

Name of the thermostat schedule.

​
starts_at
string

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

Response

OK

The response is of type object.