Create an Access Code
Last updated
Was this helpful?
Last updated
Was this helpful?
Creates a new .
device_id
String (Required)
ID of the device for which you want to create the new access code.
allow_external_modification
Boolean
Indicates whether of the code is allowed. Default: false
.
attempt_for_offline_device
Boolean
code
String
Code to be used for access.
common_code_key
String
ends_at
String
is_external_modification_allowed
Boolean
is_offline_access_code
Boolean
is_one_time_use
Boolean
max_time_rounding
String
name
String
Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as first_name
and last_name
. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called appearance
. This is an object with a name
property and, optionally, first_name
and last_name
properties (for providers that break down a name into components).
prefer_native_scheduling
Boolean
preferred_code_length
Number
Preferred code length. Only applicable if you do not specify a code
. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length.
starts_at
String
use_backup_access_code_pool
Boolean
use_offline_access_code
Boolean
Key to identify access codes that should have the same code. Any two access codes with the same common_code_key
are guaranteed to have the same code
. See also .
Date and time at which the validity of the new access code ends, in format. Must be a time in the future and after starts_at
.
Indicates whether of the code is allowed. Default: false
.
Indicates whether the access code is an .
Indicates whether the is a single-use access code.
Maximum rounding adjustment. To create a daily-bound for devices that support this feature, set this parameter to 1d
.
Indicates whether should be used for time-bound codes when supported by the provider. Default: true
.
Date and time at which the validity of the new access code starts, in format.
Indicates whether to use a provided by Seam. If true
, you can use .