Sign in

v1

latestOpenAPI 3.0.02026-07-22201291.8 MB
/access_codes

Create Multiple Linked Access Codes

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

post/access_codes/create_multiple

Request body

allow_external_modificationboolean

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

attempt_for_offline_deviceboolean
behavior_when_code_cannot_be_shared'throw' | 'create_random_code'

Desired behavior if any device cannot share a code. If throw (default), no access codes will be created if any device cannot share a code. If create_random_code, a random code will be created on devices that cannot share a code.

codestring

Code to be used for access.

device_idsstring[] required

IDs of the devices for which you want to create the new access codes.

ends_atstring

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_allowedboolean

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

namestring

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_schedulingboolean

Indicates whether native scheduling should be used for time-bound codes when supported by the provider. Default: true.

preferred_code_lengthnumber float

Preferred code length. If the affected devices do not support the preferred code length, Seam reverts to using the shortest supported code length.

starts_atstring

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

use_backup_access_code_poolboolean

Indicates whether to use a backup access code pool provided by Seam. If true, you can use /access_codes/pull_backup_access_code.

Response

OK