Update a Thermostat Schedule

PATCH /thermostats/schedules/update ⇒ void

Updates a specified thermostat schedule.

Request

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

Response

// void

Request

package main

import api "github.com/seamapi/go"
import schedules "github.com/seamapi/go/schedules"

func main() {
	client.Thermostats.Schedules.Update(
		context.Background(),
		schedules.SchedulesUpdateRequest{
			ThermostatScheduleId: api.String("89d3507e-60e3-4101-bd1b-ba066ec30ad4"),
			EndsAt:               api.String("2024-11-15T15:00:00Z"),
		},
	)
}

Response

nil

Authentication Methods

API key
Client session token
Personal access token Must also include the seam-workspace header in the request.

Request Parameters

`climate_preset_key`

Type: string Required: No

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

`ends_at`

Type: string Required: No

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

`is_override_allowed`

Type: boolean Required: No

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`

Type: number Required: No

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`

Type: string Required: No

User-friendly name to identify the thermostat schedule.

`starts_at`

Type: string Required: No

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

`thermostat_schedule_id`

Type: string Required: Yes

ID of the desired thermostat schedule.

Return Type

void

PreviousCreate a Thermostat Schedule NextDelete a Thermostat Schedule

Last updated 9 months ago

Was this helpful?