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
Copy file name to clipboardExpand all lines: docs/api/access_codes/create.md
+28Lines changed: 28 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,13 +23,17 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati
23
23
24
24
**`device_id`***String* (Required)
25
25
26
+
````
26
27
ID of the device for which you want to create the new access code.
28
+
````
27
29
28
30
---
29
31
30
32
**`allow_external_modification`***Boolean*
31
33
34
+
````
32
35
Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.
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](../../capability-guides/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes.md).
56
+
````
49
57
50
58
---
51
59
52
60
**`ends_at`***String*
53
61
62
+
````
54
63
Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.
64
+
````
55
65
56
66
---
57
67
58
68
**`is_external_modification_allowed`***Boolean*
59
69
70
+
````
60
71
Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.
72
+
````
61
73
62
74
---
63
75
64
76
**`is_offline_access_code`***Boolean*
65
77
78
+
````
66
79
Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).
80
+
````
67
81
68
82
---
69
83
70
84
**`is_one_time_use`***Boolean*
71
85
86
+
````
72
87
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.
88
+
````
73
89
74
90
---
75
91
76
92
**`max_time_rounding`***String*
77
93
94
+
````
78
95
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`.
96
+
````
79
97
80
98
---
81
99
82
100
**`name`***String*
83
101
102
+
````
84
103
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).
104
+
````
85
105
86
106
---
87
107
88
108
**`prefer_native_scheduling`***Boolean*
89
109
110
+
````
90
111
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`.
112
+
````
91
113
92
114
---
93
115
94
116
**`preferred_code_length`***Number*
95
117
118
+
````
96
119
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.
120
+
````
97
121
98
122
---
99
123
100
124
**`starts_at`***String*
101
125
126
+
````
102
127
Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
128
+
````
103
129
104
130
---
105
131
106
132
**`use_backup_access_code_pool`***Boolean*
107
133
134
+
````
108
135
Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/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).
Copy file name to clipboardExpand all lines: docs/api/access_codes/create_multiple.md
+28Lines changed: 28 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,13 +31,17 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati
31
31
32
32
**`device_ids`***Array**of UUIDs* (Required)
33
33
34
+
````
34
35
IDs of the devices for which you want to create the new access codes.
36
+
````
35
37
36
38
---
37
39
38
40
**`allow_external_modification`***Boolean*
39
41
42
+
````
40
43
Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.
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.
56
+
````
51
57
52
58
---
53
59
54
60
**`code`***String*
55
61
62
+
````
56
63
Code to be used for access.
64
+
````
57
65
58
66
---
59
67
60
68
**`ends_at`***String*
61
69
70
+
````
62
71
Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.
72
+
````
63
73
64
74
---
65
75
66
76
**`is_external_modification_allowed`***Boolean*
67
77
78
+
````
68
79
Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.
80
+
````
69
81
70
82
---
71
83
72
84
**`is_offline_access_code`***Boolean*
73
85
86
+
````
74
87
Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).
88
+
````
75
89
76
90
---
77
91
78
92
**`is_one_time_use`***Boolean*
79
93
94
+
````
80
95
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.
96
+
````
81
97
82
98
---
83
99
84
100
**`max_time_rounding`***String*
85
101
102
+
````
86
103
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`.
104
+
````
87
105
88
106
---
89
107
90
108
**`name`***String*
91
109
110
+
````
92
111
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).
112
+
````
93
113
94
114
---
95
115
96
116
**`prefer_native_scheduling`***Boolean*
97
117
118
+
````
98
119
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`.
120
+
````
99
121
100
122
---
101
123
102
124
**`preferred_code_length`***Number*
103
125
126
+
````
104
127
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.
128
+
````
105
129
106
130
---
107
131
108
132
**`starts_at`***String*
109
133
134
+
````
110
135
Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
136
+
````
111
137
112
138
---
113
139
114
140
**`use_backup_access_code_pool`***Boolean*
115
141
142
+
````
116
143
Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/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).
Copy file name to clipboardExpand all lines: docs/api/access_codes/report_device_constraints.md
+8Lines changed: 8 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,25 +25,33 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati
25
25
26
26
**`device_id`***String* (Required)
27
27
28
+
````
28
29
ID of the device for which you want to report constraints.
30
+
````
29
31
30
32
---
31
33
32
34
**`max_code_length`***Number*
33
35
36
+
````
34
37
Maximum supported code length as an integer between 4 and 20, inclusive. You can specify either `min_code_length`/`max_code_length` or `supported_code_lengths`.
38
+
````
35
39
36
40
---
37
41
38
42
**`min_code_length`***Number*
39
43
44
+
````
40
45
Minimum supported code length as an integer between 4 and 20, inclusive. You can specify either `min_code_length`/`max_code_length` or `supported_code_lengths`.
46
+
````
41
47
42
48
---
43
49
44
50
**`supported_code_lengths`***Array**of Numbers*
45
51
52
+
````
46
53
Array of supported code lengths as integers between 4 and 20, inclusive. You can specify either `supported_code_lengths` or `min_code_length`/`max_code_length`.
0 commit comments