Create a new Pod

0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
Endpoint: /v1.1/sites/{site_id}/pods
Method: POST
Parameters:
path {
site_id
type: string

Id of the site to create the Pod in

site_id
} (string)

Body (application/json):
{

"customer_reference"
customer_reference
type: string

the name of the Pod

: "string",
"max_guest_amount"
max_guest_amount
type: integer, format: int32

maximum number of guests that can be invited to the Pod

: "integer",
"locks"
locks
type: array

List of Lock ids to be added to the Pod

: [
"string"
],
"members"
members
type: array

List of Members to add to the Pod If a user exists in the system by email, they will be added to the site. If a user does not exist in the system by email, they will be invited

: [
{
"tag_id"
tag_id
type: string, format: uuid

Tag assigned to the User

: "string",
"site_user_settings"
site_user_settings
type: object

: {
"remote_access"
remote_access
type: boolean

Indicates if the remote opening feature is enabled for the site user, true by default

: "boolean"

},
"first_name"
first_name
type: string

User's First Name

: "string",
"last_name"
last_name
type: string

User's Last Name

: "string",
"email"
email
type: string

User's Email

: "string"

}

],
"access_rule"
access_rule
type: object

Request to create or update Pod's Access Rule

: {
"access_rule_type"
access_rule_type
type: string

: "string",
"schedules"
schedules
type: array

List of timetables of accessibility for selected locks At least one should be specified if access_rule_type = checkin_checkout. None can be specified when always

: [
{
"monday"
monday
type: boolean

Whether this timeschedule is valid on a Monday between start and end datetimes

: "boolean",
"tuesday"
tuesday
type: boolean

Whether this timeschedule is valid on a Tuesday between start and end datetimes

: "boolean",
"wednesday"
wednesday
type: boolean

Whether this timeschedule is valid on a Wednesday between start and end datetimes

: "boolean",
"thursday"
thursday
type: boolean

Whether this timeschedule is valid on a Thursday between start and end datetimes

: "boolean",
"friday"
friday
type: boolean

Whether this timeschedule is valid on a Friday between start and end datetimes

: "boolean",
"saturday"
saturday
type: boolean

Whether this timeschedule is valid on a Saturday between start and end datetimes

: "boolean",
"sunday"
sunday
type: boolean

Whether this timeschedule is valid on a Sunday between start and end datetimes

: "boolean",
"start_time"
start_time
type: string, format: date-span

The start of the time span on which this timeschedule is valid, for the selected days and date span.

: "string",
"end_time"
end_time
type: string, format: date-span

The end of the time span on which this timeschedule is valid, for the selected days and date span.

: "string",
"start_date"
start_date
type: string, format: date-time

The date at which the timeschedule starts beeing valid

: "string",
"end_date"
end_date
type: string, format: date-time

The date at which the timeschedule stops being valid

: "string"

}

]

},
"tags"
tags
type: array

List of Tag ids to be added to the Pod

: [
"string"
]

}
App storePlay store