The device Object for Locks
Represents a lock. The Seam API enables you to control connected smart locks from a wide variety of manufacturers, including locks that provide online and offline access code programming. Depending on the smart lock brand and model, actions that you can perform include remote unlock, remote lock, and programming access codes. You can also view a lock’s properties, capabilities, and status. Further, you can monitor for unlock and lock events. See also Webhooks.Properties
Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set.
Indicates whether the thermostat supports different climate programs for each day of the week.
Indicates whether the camera can stream live video through a camera live view session.
false while the camera is offline.Collection of capabilities that the device supports when connected to Seam. Values are
access_code, which indicates that the device can manage and utilize digital PIN codes for secure access; lock, which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; noise_detection, which indicates that the device supports monitoring and responding to ambient noise levels; thermostat, which indicates that the device can regulate and adjust indoor temperatures; battery, which indicates that the device can manage battery life and health; and phone, which indicates that the device is a mobile device, such as a smartphone. Important: Superseded by capability flags.Enum values
Enum values
access_codelocknoise_detectionthermostatbatteryphonepool
Set of key:value pairs. Adding custom metadata to a resource, such as a Connect Webview, connected account, or device, enables you to store custom information, like customer details or internal IDs from your application. Keys set to
null or to an empty string are omitted.Type of the device. The
august_lock and yale_lock values are deprecated. Use yale_access_lock in place of august_lock, and yale_access_lock or yale_home_lock in place of yale_lock.Enum values
Enum values
akuvox_lockaugust_lockbrivo_access_pointbutterflymx_panelavigilon_alta_entrydoorking_lockgenie_doorigloo_locklinear_locklockly_lockkwikset_locknuki_locksalto_lockschlage_locksmartthings_lockwyze_lockyale_lockyale_access_lockyale_home_lockyale_connect_locktwo_n_intercomcontrolbyweb_devicettlock_lockigloohome_lockfour_suites_doordormakaba_oracode_doortedee_lockakiles_lockultraloq_lockyacan_lockkeyincode_lockomnitec_lockkisi_lockaqara_locktuya_lockeufy_lockkeynest_keynoiseaware_activity_zoneminut_sensorecobee_thermostatnest_thermostathoneywell_resideo_thermostattado_thermostatsensi_thermostatsensibo_thermostatsmartthings_thermostatios_phoneandroid_phonering_cameratapo_cameraarlo_camerareolink_cameraunifi_protect_camerasonos_speakeralertify_sensorhayward_pool_systemhayward_pool
Display name of the device, defaults to nickname (if it is set) or
properties.appearance.name, otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices.Array of errors associated with the device. Each error object within the array contains two fields:
error_code and message. error_code is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. message provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.Indicates whether Seam manages the device. See also Managed and Unmanaged Devices.
Properties of the device. See Common Device Properties for shared fields and provider metadata, and the property group sections below for capability-specific fields.
Array of warnings associated with the device. Each warning object within the array contains two fields:
warning_code and message. warning_code is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. message provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.Access Codes
Indicates whether the backup access code pool is currently enabled for the device. To disable it, set this to
false using /devices/update.Constraints on access codes for the device. Seam represents each constraint as an object with a
constraint_type property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific.Time frames that may be requested when creating an offline access code, expressed as a list of options. The caller picks one option (by matching the requested duration when the options’ duration ranges do not overlap, or by
display_name when they do) and satisfies that one option’s rules. When undefined, any time frame works.Time frames that may be requested when creating an online access code, expressed as a list of options. The caller picks one option (by matching the requested duration when the options’ duration ranges do not overlap, or by
display_name when they do) and satisfies that one option’s rules. When undefined, any time frame works.Indicates whether the device supports a backup access code pool.