Update a Thermostat Schedule

• Request Parameters

• Response

• Examples

Updates a specified thermostat schedule.

Signature

PATCH /thermostats/schedules/update ⇒ 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 desired thermostat schedule.

---

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

User-friendly name to identify the thermostat schedule.

---

starts_at String

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

---

Response

void

---

Examples

Update a thermostat schedule

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

JavaScript

Code

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

Output

// void

Python

Code

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

Output

None

Ruby

Code

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

Output

nil

PHP

Code

<?php
$seam->thermostats->schedules->update(
    thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4",
    ends_at: "2024-11-15T15:00:00Z"
);

Output

null

Seam CLI

Code

seam thermostats schedules update --thermostat_schedule_id "89d3507e-60e3-4101-bd1b-ba066ec30ad4" --ends_at "2024-11-15T15:00:00Z"

Output

{}

Go

Code

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"),
		},
	)
}

Output

nil

cURL

Code

curl --include --request POST "https://connect.getseam.com/thermostats/schedules/update" \
  --header "Authorization: Bearer $SEAM_API_KEY" \
  --json @- <<EOF
{
  "thermostat_schedule_id": "89d3507e-60e3-4101-bd1b-ba066ec30ad4",
  "ends_at": "2024-11-15T15:00:00Z"
}
EOF

Output

{}