@seamapi/http - v2.1.0
    Preparing search index...

    Type Alias ThermostatsSchedulesCreateParameters

    type ThermostatsSchedulesCreateParameters = {
        climate_preset_key: string;
        device_id: string;
        ends_at: string;
        is_override_allowed?: boolean;
        max_override_period_minutes?: number;
        name?: string;
        starts_at: string;
    }
    Index
    climate_preset_key device_id ends_at is_override_allowed? max_override_period_minutes? name? starts_at
    climate_preset_key: string

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

    device_id: string

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

    ends_at: string

    Date and time at which the new 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 new 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 new thermostat schedule starts, in ISO 8601 format.

    Settings
    Member Visibility

    On This Page
    Properties