ReadonlydefaultsReadonlyltsStaticltsCreates new access codes that share a common code across multiple devices.
Users with more than one door lock in a property may want to create groups of linked access codes, all of which have the same code (PIN). For example, a short-term rental host may want to provide guests the same PIN for both a front door lock and a back door lock.
If you specify a custom code, Seam assigns this custom code to each of the resulting access codes. However, in this case, Seam does not link these access codes together with a common_code_key. That is, common_code_key remains null for these access codes.
If you want to change these access codes that are not linked by a common_code_key, you cannot use /access_codes/update_multiple. However, you can update each of these access codes individually, using /access_codes/update.
See also Creating and Updating Multiple Linked Access Codes.
For granting a person access to a space, Access Grants are the default and recommended approach and work across both standalone smart locks and access systems. Use the lower-level Access Codes API directly only when you specifically need to manage individual PIN codes.
Deletes an access code.
Generates a code for an access code, given a device ID.
Returns a specified access code.
You must specify either access_code_id or both device_id and code.
Optionalparameters: AccessCodesGetParametersReturns a list of all access codes.
Specify device_id, access_code_ids, access_method_id, access_grant_id, or access_grant_key.
Optionalparameters: AccessCodesListParametersRetrieves a backup access code for an access code. See also Managing Backup Access Codes.
A backup access code pool is a collection of pre-programmed access codes stored on a device, ready for use. These codes are programmed in addition to the regular access codes on Seam, serving as a safety net for any issues with the primary codes. If there's ever a complication with a primary access code—be it due to intermittent connectivity, manual removal from a device, or provider outages—a backup code can be retrieved. Its end time can then be adjusted to align with the original code, facilitating seamless and uninterrupted access.
You can pull a backup access code from the pool at any time. These backup codes are guaranteed to work immediately and automatically programmed to be removed from the device after the access code ends.
You can only pull backup access codes for time-bound access codes.
Before pulling a backup access code, make sure that the device's properties.supports_backup_access_code_pool is true. Then, to activate the backup pool, set use_backup_access_code_pool to true when creating an access code.
Enables you to report access code-related constraints for a device. Currently, supports reporting supported code length constraints for SmartThings devices.
Specify either supported_code_lengths or min_code_length/max_code_length.
Updates a specified active or upcoming access code.
See also Modifying Access Codes.
Updates access codes that share a common code across multiple devices.
Specify the common_code_key to identify the set of access codes that you want to update.
See also Update Linked Access Codes.
StaticfromStaticfromStaticfromStaticfromStaticfromStaticfrom
Creates a new access code. For granting access, we recommend Access Grants instead: they work across both standalone smart locks and access control systems and manage the underlying codes for you. Use this low-level endpoint only when you need direct control over a code on a single device, such as setting a custom PIN value.