You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
feat: relocate Smart Locks and ACS to Low-Level APIs in Mintlify (#1121)
Ports the #1115 structural change into the Mintlify docs (now the
source of truth), on top of Dawn's #1119 polish — done by hand rather
than re-running the migration script so her edits are preserved.
- Move smart-locks and access-systems MDX trees under low-level-apis/
- docs.json Guides tab: new bottom "Low-Level APIs" group with nested
Smart Locks / Access Control Systems sub-groups (matches the
Low-Level APIs group Dawn already added to the API Reference tab)
- Warning banners on both section indexes: low-level API, use Access
Grants for granting, talk to the Seam team before building on them
- Pointer hints on the granting sub-pages (access codes, managing
credentials, ACS quick starts, ACS user management)
- Remove the stale 'Access Grants in Alpha' notice from the
card-encoding guide (#1117)
- Rewrite ~166 internal links to the new paths; add docs.json redirects
for the two moved subtrees
Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
-[Connect an Access System to Seam](capability-guides/access-systems/connect-an-acs-to-seam/index)
85
-
-[Retrieving ACS System Details](capability-guides/access-systems/connect-an-acs-to-seam/retrieving-acs-system-details)
86
-
-[Access Control System Resources](capability-guides/access-systems/connect-an-acs-to-seam/access-control-system-resources)
87
-
-[Understanding Access Control System Differences](capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences)
-[Assigning Credentials to ACS Users](capability-guides/access-systems/managing-credentials/assigning-credentials-to-users)
94
-
-[Listing Credentials and Associated Entrances](capability-guides/access-systems/managing-credentials/listing-credentials-and-associated-entrances)
95
-
-[Working with Card Encoders and Scanners](capability-guides/access-systems/working-with-card-encoders-and-scanners/index)
96
-
-[Creating and Encoding Card-based Credentials](capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials)
97
-
-[Creating and Encoding Card Access Methods](capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-access-methods)
-[Connect an Access System to Seam](low-level-apis/access-systems/connect-an-acs-to-seam/index)
85
+
-[Retrieving ACS System Details](low-level-apis/access-systems/connect-an-acs-to-seam/retrieving-acs-system-details)
86
+
-[Access Control System Resources](low-level-apis/access-systems/connect-an-acs-to-seam/access-control-system-resources)
87
+
-[Understanding Access Control System Differences](low-level-apis/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences)
-[Assigning Credentials to ACS Users](low-level-apis/access-systems/managing-credentials/assigning-credentials-to-users)
94
+
-[Listing Credentials and Associated Entrances](low-level-apis/access-systems/managing-credentials/listing-credentials-and-associated-entrances)
95
+
-[Working with Card Encoders and Scanners](low-level-apis/access-systems/working-with-card-encoders-and-scanners/index)
96
+
-[Creating and Encoding Card-based Credentials](low-level-apis/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials)
97
+
-[Creating and Encoding Card Access Methods](low-level-apis/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-access-methods)
Copy file name to clipboardExpand all lines: mintlify-docs/api/access_codes/create.mdx
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ title: 'Create an Access Code'
6
6
-[Response](#response)
7
7
-[Examples](#examples)
8
8
9
-
Creates a new [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
9
+
Creates a new [access code](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes).
10
10
11
11
<Tabs>
12
12
<Tabtitle="JavaScript">
@@ -295,7 +295,7 @@ ID of the device for which you want to create the new access code.
295
295
296
296
**`allow_external_modification`**_Boolean_
297
297
298
-
Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.
298
+
Indicates whether [external modification](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.
299
299
300
300
---
301
301
@@ -311,7 +311,7 @@ Code to be used for access.
311
311
312
312
**`common_code_key`**_String_
313
313
314
-
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 [Creating and Updating Multiple Linked Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes).
314
+
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 [Creating and Updating Multiple Linked Access Codes](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes).
315
315
316
316
---
317
317
@@ -323,25 +323,25 @@ Date and time at which the validity of the new access code ends, in [ISO 8601](h
323
323
324
324
**`is_external_modification_allowed`**_Boolean_
325
325
326
-
Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.
326
+
Indicates whether [external modification](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.
327
327
328
328
---
329
329
330
330
**`is_offline_access_code`**_Boolean_
331
331
332
-
Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).
332
+
Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes/offline-access-codes).
333
333
334
334
---
335
335
336
336
**`is_one_time_use`**_Boolean_
337
337
338
-
Indicates whether the [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) is a single-use access code.
338
+
Indicates whether the [offline access code](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes/offline-access-codes) is a single-use access code.
339
339
340
340
---
341
341
342
342
**`max_time_rounding`**_String_
343
343
344
-
Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`.
344
+
Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`.
345
345
346
346
---
347
347
@@ -359,7 +359,7 @@ To help your users identify codes set by Seam, Seam provides the name exactly as
359
359
360
360
**`prefer_native_scheduling`**_Boolean_
361
361
362
-
Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`.
362
+
Indicates whether [native scheduling](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`.
363
363
364
364
---
365
365
@@ -377,7 +377,7 @@ Date and time at which the validity of the new access code starts, in [ISO 8601]
377
377
378
378
**`use_backup_access_code_pool`**_Boolean_
379
379
380
-
Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code).
380
+
Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code).
Creates new [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that share a common code across multiple devices.
8
+
Creates new [access codes](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes) that share a common code across multiple devices.
9
9
10
10
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.
11
11
12
12
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.
13
13
14
14
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`.
15
15
16
-
See also [Creating and Updating Multiple Linked Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes).
16
+
See also [Creating and Updating Multiple Linked Access Codes](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes).
17
17
18
18
<Tabs>
19
19
<Tabtitle="JavaScript">
@@ -355,7 +355,7 @@ IDs of the devices for which you want to create the new access codes.
355
355
356
356
**`allow_external_modification`**_Boolean_
357
357
358
-
Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.
358
+
Indicates whether [external modification](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.
359
359
360
360
---
361
361
@@ -383,7 +383,7 @@ Date and time at which the validity of the new access code ends, in [ISO 8601](h
383
383
384
384
**`is_external_modification_allowed`**_Boolean_
385
385
386
-
Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.
386
+
Indicates whether [external modification](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.
387
387
388
388
---
389
389
@@ -401,7 +401,7 @@ To help your users identify codes set by Seam, Seam provides the name exactly as
401
401
402
402
**`prefer_native_scheduling`**_Boolean_
403
403
404
-
Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`.
404
+
Indicates whether [native scheduling](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`.
405
405
406
406
---
407
407
@@ -419,7 +419,7 @@ Date and time at which the validity of the new access code starts, in [ISO 8601]
419
419
420
420
**`use_backup_access_code_pool`**_Boolean_
421
421
422
-
Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code).
422
+
Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code).
0 commit comments