Access Codes
The access_code Object
Represents a smart lock access code.
An access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly. Using the Seam Access Code API, you can easily generate access codes on the hundreds of door lock models with which we integrate.
Seam supports programming two types of access codes: ongoing and time-bound. To differentiate between the two, refer to the type property of the access code. Ongoing codes display as ongoing, whereas time-bound codes are labeled time_bound. An ongoing access code is active, until it has been removed from the device. To specify an ongoing access code, leave both starts_at and ends_at empty. A time-bound access code will be programmed at the starts_at time and removed at the ends_at time.
In addition, for certain devices, Seam also supports offline access codes. Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code.
{
access_code_id: [example value],
code: [example value],
common_code_key: [example value],
created_at: [example value],
device_id: [example value],
ends_at: [example value],
errors: [example value],
is_backup: [example value],
is_backup_access_code_available: [example value],
is_external_modification_allowed: [example value],
is_managed: [example value],
is_offline_access_code: [example value],
is_one_time_use: [example value],
is_scheduled_on_device: [example value],
is_waiting_for_code_assignment: [example value],
name: [example value],
pulled_backup_access_code_id: [example value],
starts_at: [example value],
status: [example value],
type: [example value],
warnings: [example value]
}Properties
access_code_id UUID
Unique identifier for the access code.
code String
Code used for access. Typically, a numeric or alphanumeric string.
common_code_key String
Unique identifier for a group of access codes that share the same code.
created_at Datetime
Date and time at which the access code was created.
device_id UUID
Unique identifier for the device associated with the access code.
ends_at Datetime
Date and time after which the time-bound access code becomes inactive.
errors List of Objects
Errors associated with the access code.
The specific structure of each object in this list depends on the value of its error_code field.
Variants:
smartthings_failed_to_set_access_code
Failed to set code on SmartThings device.
created_at Datetime
Date and time at which Seam created the error.
error_code Enum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
is_access_code_error Boolean
Indicates that this is an access code error.
message String
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
smartthings_failed_to_set_after_multiple_retries
Failed to set code after multiple retries.
created_at Datetime
Date and time at which Seam created the error.
error_code Enum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
is_access_code_error Boolean
Indicates that this is an access code error.
message String
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
smartthings_no_free_slots_available
No free slots available on the device.
created_at Datetime
Date and time at which Seam created the error.
error_code Enum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
is_access_code_error Boolean
Indicates that this is an access code error.
message String
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
failed_to_set_on_device
Failed to set code on device.
created_at Datetime
Date and time at which Seam created the error.
error_code Enum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
is_access_code_error Boolean
Indicates that this is an access code error.
message String
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
failed_to_remove_from_device
Failed to remove code from device.
created_at Datetime
Date and time at which Seam created the error.
error_code Enum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
is_access_code_error Boolean
Indicates that this is an access code error.
message String
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
duplicate_code_on_device
Duplicate access code detected on device.
created_at Datetime
Date and time at which Seam created the error.
error_code Enum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
is_access_code_error Boolean
Indicates that this is an access code error.
message String
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
duplicate_code_attempt_prevented
An attempt to modify this access code was prevented.
created_at Datetime
Date and time at which Seam created the error.
error_code Enum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
is_access_code_error Boolean
Indicates that this is an access code error.
message String
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
no_space_for_access_code_on_device
No space for access code on device.
created_at Datetime
Date and time at which Seam created the error.
error_code Enum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
is_access_code_error Boolean
Indicates that this is an access code error.
message String
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
igloohome_bridge_too_many_pending_jobs
Igloohome bridge has too many pending jobs in the queue.
created_at Datetime
Date and time at which Seam created the error.
error_code Enum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
is_access_code_error Boolean
Indicates that this is an access code error.
message String
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
igloohome_bridge_offline
Igloohome bridge is offline.
created_at Datetime
Date and time at which Seam created the error.
error_code Enum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
is_access_code_error Boolean
Indicates that this is an access code error.
message String
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
igloohome_offline_access_code_no_variance_available
Lock has reached maximum amount of codes.
created_at Datetime
Date and time at which Seam created the error.
error_code Enum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
is_access_code_error Boolean
Indicates that this is an access code error.
message String
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
kwikset_unable_to_confirm_code
Unable to confirm that the access code is set on Kwikset device.
created_at Datetime
Date and time at which Seam created the error.
error_code Enum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
is_access_code_error Boolean
Indicates that this is an access code error.
message String
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
kwikset_unable_to_confirm_deletion
Unable to confirm the deletion of the access code on Kwikset device.
created_at Datetime
Date and time at which Seam created the error.
error_code Enum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
is_access_code_error Boolean
Indicates that this is an access code error.
message String
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
code_modified_external_to_seam
Code was modified or removed externally after Seam successfully set it on the device.
created_at Datetime
Date and time at which Seam created the error.
error_code Enum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
is_access_code_error Boolean
Indicates that this is an access code error.
message String
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
august_lock_invalid_code_length
Invalid code length for August lock.
created_at Datetime
Date and time at which Seam created the error.
error_code Enum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
is_access_code_error Boolean
Indicates that this is an access code error.
message String
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
august_device_programming_delay
Access code has not yet been fully moved to the device.
created_at Datetime
Date and time at which Seam created the error.
error_code Enum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
is_access_code_error Boolean
Indicates that this is an access code error.
message String
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
august_device_slots_full
All access code slots on the device are full.
created_at Datetime
Date and time at which Seam created the error.
error_code Enum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
is_access_code_error Boolean
Indicates that this is an access code error.
message String
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
august_lock_missing_keypad
August lock is missing a keypad.
created_at Datetime
Date and time at which Seam created the error.
error_code Enum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
is_access_code_error Boolean
Indicates that this is an access code error.
message String
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
august_lock_temporarily_offline
August lock is temporarily offline.
created_at Datetime
Date and time at which Seam created the error.
error_code Enum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
is_access_code_error Boolean
Indicates that this is an access code error.
message String
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
salto_ks_user_not_subscribed
Salto site user is not subscribed.
created_at Datetime
Date and time at which Seam created the error.
error_code Enum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
is_access_code_error Boolean
Indicates that this is an access code error.
message String
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
hubitat_device_programming_delay
Access code has not yet been fully moved to the device.
created_at Datetime
Date and time at which Seam created the error.
error_code Enum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
is_access_code_error Boolean
Indicates that this is an access code error.
message String
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
hubitat_no_free_positions_available
No free positions available on the device.
created_at Datetime
Date and time at which Seam created the error.
error_code Enum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
is_access_code_error Boolean
Indicates that this is an access code error.
message String
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
wyze_duplicate_code_name
Duplicate access code name detected.
created_at Datetime
Date and time at which Seam created the error.
error_code Enum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
is_access_code_error Boolean
Indicates that this is an access code error.
message String
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
wyze_potential_duplicate_code
Potential duplicate access code detected.
created_at Datetime
Date and time at which Seam created the error.
error_code Enum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
is_access_code_error Boolean
Indicates that this is an access code error.
message String
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
dormakaba_oracode_no_valid_user_level
No valid user level for Oracode.
created_at Datetime
Date and time at which Seam created the error.
error_code Enum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
is_access_code_error Boolean
Indicates that this is an access code error.
message String
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
account_disconnected
Account is disconnected
created_at Datetime
error_code Enum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
is_connected_account_error Boolean
is_device_error Boolean
message String
salto_ks_subscription_limit_exceeded
Salto site user limit reached.
created_at Datetime
error_code Enum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
is_connected_account_error Boolean
is_device_error Boolean
message String
device_offline
Device is offline
created_at Datetime
error_code Enum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
is_device_error Boolean
message String
device_removed
Device has been removed
created_at Datetime
error_code Enum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
is_device_error Boolean
message String
hub_disconnected
Hub is disconnected
created_at Datetime
error_code Enum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
is_device_error Boolean
message String
device_disconnected
Device is disconnected
created_at Datetime
error_code Enum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
is_device_error Boolean
message String
empty_backup_access_code_pool
The backup access code pool is empty.
created_at Datetime
error_code Enum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
is_device_error Boolean
message String
august_lock_not_authorized
User is not authorized to use the August Lock.
created_at Datetime
error_code Enum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
is_device_error Boolean
message String
august_lock_missing_bridge
Lock is not connected to the Seam Bridge.
created_at Datetime
error_code Enum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
is_device_error Boolean
message String
ttlock_lock_not_paired_to_gateway
Lock is not paired with a Gateway.
created_at Datetime
error_code Enum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
is_device_error Boolean
message String
missing_device_credentials
Missing device credentials.
created_at Datetime
error_code Enum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
is_device_error Boolean
message String
auxiliary_heat_running
The auxiliary heat is running.
created_at Datetime
error_code Enum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
is_device_error Boolean
message String
subscription_required
Subscription required to connect.
created_at Datetime
error_code Enum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
is_device_error Boolean
message String
invalid_credentials
Credentials provided were invalid.
created_at Datetime
Date and time at which Seam created the error.
error_code Enum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
is_bridge_error Boolean
Indicates whether the error is related to Seam Bridge.
is_connected_account_error Boolean
Indicates whether the error is related specifically to the connected account.
message String
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
bridge_disconnected
Indicates that the Seam API cannot communicate with Seam Bridge, for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also Troubleshooting Your Access Control System.
created_at Datetime
Date and time at which Seam created the error.
error_code Enum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
is_bridge_error Boolean
Indicates whether the error is related to Seam Bridge.
is_connected_account_error Boolean
Indicates whether the error is related specifically to the connected account.
message String
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
is_backup Boolean
Indicates whether the access code is a backup code.
is_backup_access_code_available Boolean
Indicates whether a backup access code is available for use if the primary access code is lost or compromised.
is_external_modification_allowed Boolean
Indicates whether changes to the access code from external sources are permitted.
is_managed Boolean
Indicates whether Seam manages the access code.
is_offline_access_code Boolean
Indicates whether the access code is intended for use in offline scenarios. If true, this code can be created on a device without a network connection.
is_one_time_use Boolean
Indicates whether the access code can only be used once. If true, the code becomes invalid after the first use.
is_scheduled_on_device Boolean
Indicates whether the code is set on the device according to a preconfigured schedule.
is_waiting_for_code_assignment Boolean
Indicates whether the access code is waiting for a code assignment.
name String
Name of the 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).
pulled_backup_access_code_id UUID
Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code.
starts_at Datetime
Date and time at which the time-bound access code becomes active.
status Enum
Current status of the access code within the operational lifecycle. Values are setting, a transitional phase that indicates that the code is being configured or activated; set, which indicates that the code is active and operational; unset, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; removing, which indicates a transitional period in which the code is being deleted or made inactive; and unknown, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. See also Lifecycle of Access Codes.
type Enum
Nature of the access code. Values are ongoing for access codes that are active continuously until deactivated manually or time_bound for access codes that have a specific duration.
warnings List of Objects
Warnings associated with the access code.
The specific structure of each object in this list depends on the value of its warning_code field.
Variants:
smartthings_failed_to_set_access_code
Failed to set code on SmartThings device.
created_at Datetime
Date and time at which Seam created the warning.
message String
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
warning_code Enum
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
Enum values:
schlage_detected_duplicate
Duplicate access code detected.
created_at Datetime
Date and time at which Seam created the warning.
message String
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
warning_code Enum
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
Enum values:
schlage_creation_outage
Received an error when attempting to create this code.
created_at Datetime
Date and time at which Seam created the warning.
message String
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
warning_code Enum
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
Enum values:
code_modified_external_to_seam
Code was modified or removed externally after Seam successfully set it on the device.
created_at Datetime
Date and time at which Seam created the warning.
message String
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
warning_code Enum
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
Enum values:
delay_in_setting_on_device
Delay in setting code on device.
created_at Datetime
Date and time at which Seam created the warning.
message String
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
warning_code Enum
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
Enum values:
delay_in_removing_from_device
Delay in removing code from device.
created_at Datetime
Date and time at which Seam created the warning.
message String
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
warning_code Enum
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
Enum values:
third_party_integration_detected
Third-party integration detected that may cause access codes to fail.
created_at Datetime
Date and time at which Seam created the warning.
message String
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
warning_code Enum
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
Enum values:
august_device_programming_delay
Access code has not yet been fully moved to the device.
created_at Datetime
Date and time at which Seam created the warning.
message String
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
warning_code Enum
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
Enum values:
august_lock_temporarily_offline
August lock is temporarily offline.
created_at Datetime
Date and time at which Seam created the warning.
message String
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
warning_code Enum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
igloo_algopin_must_be_used_within_24_hours
Algopins must be used within 24 hours.
created_at Datetime
Date and time at which Seam created the warning.
message String
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
warning_code Enum
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
Enum values:
management_transferred
Management was transferred to another workspace.
created_at Datetime
Date and time at which Seam created the warning.
message String
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
warning_code Enum
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
Enum values:
kwikset_unable_to_confirm_code
Unable to confirm that the access code is set on Kwikset device.
created_at Datetime
Date and time at which Seam created the warning.
message String
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
warning_code Enum
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
Enum values:
Errors
smartthings_failed_to_set_access_code
Failed to set code on SmartThings device.
smartthings_failed_to_set_after_multiple_retries
Failed to set code after multiple retries.
smartthings_no_free_slots_available
No free slots available on the device.
failed_to_set_on_device
Failed to set code on device.
failed_to_remove_from_device
Failed to remove code from device.
duplicate_code_on_device
Duplicate access code detected on device.
duplicate_code_attempt_prevented
An attempt to modify this access code was prevented.
no_space_for_access_code_on_device
No space for access code on device.
igloohome_bridge_too_many_pending_jobs
Igloohome bridge has too many pending jobs in the queue.
igloohome_bridge_offline
Igloohome bridge is offline.
igloohome_offline_access_code_no_variance_available
Lock has reached maximum amount of codes.
kwikset_unable_to_confirm_code
Unable to confirm that the access code is set on Kwikset device.
kwikset_unable_to_confirm_deletion
Unable to confirm the deletion of the access code on Kwikset device.
code_modified_external_to_seam
Code was modified or removed externally after Seam successfully set it on the device.
august_lock_invalid_code_length
Invalid code length for August lock.
august_device_programming_delay
Access code has not yet been fully moved to the device.
august_device_slots_full
All access code slots on the device are full.
august_lock_missing_keypad
August lock is missing a keypad.
august_lock_temporarily_offline
August lock is temporarily offline.
salto_ks_user_not_subscribed
Salto site user is not subscribed.
hubitat_device_programming_delay
Access code has not yet been fully moved to the device.
hubitat_no_free_positions_available
No free positions available on the device.
wyze_duplicate_code_name
Duplicate access code name detected.
wyze_potential_duplicate_code
Potential duplicate access code detected.
dormakaba_oracode_no_valid_user_level
No valid user level for Oracode.
account_disconnected
Account is disconnected
salto_ks_subscription_limit_exceeded
Salto site user limit reached.
device_offline
Device is offline
device_removed
Device has been removed
hub_disconnected
Hub is disconnected
device_disconnected
Device is disconnected
empty_backup_access_code_pool
The backup access code pool is empty.
august_lock_not_authorized
User is not authorized to use the August Lock.
august_lock_missing_bridge
Lock is not connected to the Seam Bridge.
ttlock_lock_not_paired_to_gateway
Lock is not paired with a Gateway.
missing_device_credentials
Missing device credentials.
auxiliary_heat_running
The auxiliary heat is running.
subscription_required
Subscription required to connect.
invalid_credentials
Credentials provided were invalid.
bridge_disconnected
Indicates that the Seam API cannot communicate with Seam Bridge, for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also Troubleshooting Your Access Control System.
Warnings
smartthings_failed_to_set_access_code
Failed to set code on SmartThings device.
schlage_detected_duplicate
Duplicate access code detected.
schlage_creation_outage
Received an error when attempting to create this code.
code_modified_external_to_seam
Code was modified or removed externally after Seam successfully set it on the device.
delay_in_setting_on_device
Delay in setting code on device.
delay_in_removing_from_device
Delay in removing code from device.
third_party_integration_detected
Third-party integration detected that may cause access codes to fail.
august_device_programming_delay
Access code has not yet been fully moved to the device.
august_lock_temporarily_offline
August lock is temporarily offline.
igloo_algopin_must_be_used_within_24_hours
Algopins must be used within 24 hours.
management_transferred
Management was transferred to another workspace.
kwikset_unable_to_confirm_code
Unable to confirm that the access code is set on Kwikset device.
Events
access_code.created
An access code was created.
Properties
access_code_id UUID
ID of the affected access code.
connected_account_id UUID
ID of the connected account associated with the affected access codes.
created_at Datetime
Date and time at which the event was created.
device_id UUID
ID of the device associated with the affected access code.
event_id UUID
ID of the event.
event_type Enum
Value: access_code.created
occurred_at Datetime
Date and time at which the event occurred.
workspace_id UUID
ID of the workspace associated with the event.
access_code.changed
An access code was changed.
Properties
access_code_id UUID
ID of the affected access code.
connected_account_id UUID
ID of the connected account associated with the affected access codes.
created_at Datetime
Date and time at which the event was created.
device_id UUID
ID of the device associated with the affected access code.
event_id UUID
ID of the event.
event_type Enum
Value: access_code.changed
occurred_at Datetime
Date and time at which the event occurred.
workspace_id UUID
ID of the workspace associated with the event.
access_code.scheduled_on_device
An access code was scheduled natively on a device.
Properties
access_code_id UUID
ID of the affected access code.
code String
Code for the affected access code.
connected_account_id UUID
ID of the connected account associated with the affected access codes.
created_at Datetime
Date and time at which the event was created.
device_id UUID
ID of the device associated with the affected access code.
event_id UUID
ID of the event.
event_type Enum
Value: access_code.scheduled_on_device
occurred_at Datetime
Date and time at which the event occurred.
workspace_id UUID
ID of the workspace associated with the event.
access_code.set_on_device
An access code was set on a device.
Properties
access_code_id UUID
ID of the affected access code.
code String
Code for the affected access code.
connected_account_id UUID
ID of the connected account associated with the affected access codes.
created_at Datetime
Date and time at which the event was created.
device_id UUID
ID of the device associated with the affected access code.
event_id UUID
ID of the event.
event_type Enum
Value: access_code.set_on_device
occurred_at Datetime
Date and time at which the event occurred.
workspace_id UUID
ID of the workspace associated with the event.
access_code.removed_from_device
An access code was removed from a device.
Properties
access_code_id UUID
ID of the affected access code.
connected_account_id UUID
ID of the connected account associated with the affected access codes.
created_at Datetime
Date and time at which the event was created.
device_id UUID
ID of the device associated with the affected access code.
event_id UUID
ID of the event.
event_type Enum
Value: access_code.removed_from_device
occurred_at Datetime
Date and time at which the event occurred.
workspace_id UUID
ID of the workspace associated with the event.
access_code.delay_in_setting_on_device
There was an unusually long delay in setting an access code on a device.
Properties
access_code_id UUID
ID of the affected access code.
connected_account_id UUID
ID of the connected account associated with the affected access codes.
created_at Datetime
Date and time at which the event was created.
device_id UUID
ID of the device associated with the affected access code.
event_id UUID
ID of the event.
event_type Enum
Value: access_code.delay_in_setting_on_device
occurred_at Datetime
Date and time at which the event occurred.
workspace_id UUID
ID of the workspace associated with the event.
access_code.failed_to_set_on_device
An access code failed to be set on a device.
Properties
access_code_id UUID
ID of the affected access code.
connected_account_id UUID
ID of the connected account associated with the affected access codes.
created_at Datetime
Date and time at which the event was created.
device_id UUID
ID of the device associated with the affected access code.
event_id UUID
ID of the event.
event_type Enum
Value: access_code.failed_to_set_on_device
occurred_at Datetime
Date and time at which the event occurred.
workspace_id UUID
ID of the workspace associated with the event.
access_code.deleted
An access code was deleted.
Properties
access_code_id UUID
ID of the affected access code.
code String
Code for the affected access code.
connected_account_id UUID
ID of the connected account associated with the affected access codes.
created_at Datetime
Date and time at which the event was created.
device_id UUID
ID of the device associated with the affected access code.
event_id UUID
ID of the event.
event_type Enum
Value: access_code.deleted
occurred_at Datetime
Date and time at which the event occurred.
workspace_id UUID
ID of the workspace associated with the event.
access_code.delay_in_removing_from_device
There was an unusually long delay in removing an access code from a device.
Properties
access_code_id UUID
ID of the affected access code.
connected_account_id UUID
ID of the connected account associated with the affected access codes.
created_at Datetime
Date and time at which the event was created.
device_id UUID
ID of the device associated with the affected access code.
event_id UUID
ID of the event.
event_type Enum
Value: access_code.delay_in_removing_from_device
occurred_at Datetime
Date and time at which the event occurred.
workspace_id UUID
ID of the workspace associated with the event.
access_code.failed_to_remove_from_device
An access code failed to be removed from a device.
Properties
access_code_id UUID
ID of the affected access code.
connected_account_id UUID
ID of the connected account associated with the affected access codes.
created_at Datetime
Date and time at which the event was created.
device_id UUID
ID of the device associated with the affected access code.
event_id UUID
ID of the event.
event_type Enum
Value: access_code.failed_to_remove_from_device
occurred_at Datetime
Date and time at which the event occurred.
workspace_id UUID
ID of the workspace associated with the event.
access_code.modified_external_to_seam
An access code was modified outside of Seam.
Properties
access_code_id UUID
ID of the affected access code.
connected_account_id UUID
ID of the connected account associated with the affected access codes.
created_at Datetime
Date and time at which the event was created.
device_id UUID
ID of the device associated with the affected access code.
event_id UUID
ID of the event.
event_type Enum
Value: access_code.modified_external_to_seam
occurred_at Datetime
Date and time at which the event occurred.
workspace_id UUID
ID of the workspace associated with the event.
access_code.deleted_external_to_seam
An access code was deleted outside of Seam.
Properties
access_code_id UUID
ID of the affected access code.
connected_account_id UUID
ID of the connected account associated with the affected access codes.
created_at Datetime
Date and time at which the event was created.
device_id UUID
ID of the device associated with the affected access code.
event_id UUID
ID of the event.
event_type Enum
Value: access_code.deleted_external_to_seam
occurred_at Datetime
Date and time at which the event occurred.
workspace_id UUID
ID of the workspace associated with the event.
access_code.backup_access_code_pulled
A backup access code was pulled from the backup access code pool and set on a device.
Properties
access_code_id UUID
ID of the affected access code.
backup_access_code_id String
connected_account_id UUID
ID of the connected account associated with the affected access codes.
created_at Datetime
Date and time at which the event was created.
device_id UUID
ID of the device associated with the affected access code.
event_id UUID
ID of the event.
event_type Enum
Value: access_code.backup_access_code_pulled
occurred_at Datetime
Date and time at which the event occurred.
workspace_id UUID
ID of the workspace associated with the event.
Endpoints
Creates a new access code.
Creates new access codes that share a common code across multiple devices.
Deletes an access code.
Generates a code for an access code, given a device ID.
Returns a specified access code.
Returns a list of all access codes.
/access_codes/pull_backup_access_code
Retrieves a backup access code for an access code. See also Managing Backup Access Codes.
/access_codes/report_device_constraints
Enables you to report access code-related constraints for a device. Currently, supports reporting supported code length constraints for SmartThings devices.
Updates a specified active or upcoming access code.
Updates access codes that share a common code across multiple devices.
Last updated
Was this helpful?