Skip to main content
POST

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.

is_offline_access_code
boolean

Indicates whether the access code is an offline access code.

is_one_time_use
boolean

Indicates whether the offline access code is a single-use access code.

max_time_rounding
enum<string>

Maximum rounding adjustment. To create a daily-bound offline access code for devices that support this feature, set this parameter to 1d.

Available options:
1hour,
1day,
1h,
1d
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.

prefer_native_scheduling
boolean

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

preferred_code_length
number<float>

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

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
use_backup_access_code_pool
boolean

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

use_offline_access_code
boolean
deprecated

Deprecated. Use is_offline_access_code instead.

Response

OK

The response is of type object.