Update an Access Code

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

access_code_id

string<uuid>

required

ID of the access code that you want to update.

allow_external_modification

boolean

Indicates whether external modification of the code is allowed. Default: false.

attempt_for_offline_device

boolean

default:true

code

string

Code to be used for access.

Required string length: 4 - 12

Pattern: ^\d+$

device_id

string<uuid>

ID of the device containing the access code that you want to update.

ends_at

string

Date and time at which the validity of the new access code ends, in ISO 8601 format. Must be a time in the future and after starts_at.

is_external_modification_allowed

boolean

Indicates whether external modification of the code is allowed. Default: false.

is_managed

boolean

Indicates whether the access code is managed through Seam. Note that to convert an unmanaged access code into a managed access code, use /access_codes/unmanaged/convert_to_managed.

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).

starts_at

string

Date and time at which the validity of the new access code starts, in ISO 8601 format.

type

enum<string>

Type to which you want to convert the access code. To convert a time-bound access code to an ongoing access code, set type to ongoing. See also Changing a time-bound access code to permanent access.

Available options:

ongoing,

time_bound

Response

The response is of type object.

Getting Started

Granting Access

Devices and Systems

Setup

Monitoring

Low-Level APIs

Update an Access Code

Authorizations

Body

Response