Update a Thermostat Schedule

Updates a specified thermostat schedule.

Specify the thermostat_schedule_id of the desired thermostat schedule, along with the desired updated settings for the thermostat schedule.

Code

await seam.thermostats.schedules.update({
  thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4",
  ends_at: "2024-11-15T15:00:00Z",
});

Output

// void
Authentication Methods
  • API key

  • Client session token

  • Personal access token Must also include the seam-workspace header in the request.

To learn more, see Authentication.

Request Parameters

thermostat_schedule_id String (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 Number

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.


starts_at String

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


Response

void


Examples

Last updated

Was this helpful?