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/{pod_id}/guests
Method: PATCH
Parameters:
path {site_id
type: stringId of the Site
site_id} (string)
path {pod_id
type: stringId of the Pod in the Site
pod_id} (string)
Body (application/json):
{
"add_guests"add_guests
type: arrayList of Guests to be added 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.
: [
{
"access_rule"access_rule
type: objectRequest to setup access rule for specific pod guest
: {
"locks"locks
type: arrayList of locks to be accessible through this access rule. At least one should be specified if access_rule_type = custom. None can be specified when always
: [
"string"
],
"access_rule_type"access_rule_type
type: string: "string",
"schedules"schedules
type: arrayList of timetables of accessibility for selected locks At least one should be specified if access_rule_type = custom. None can be specified when always
: [
{
"monday"monday
type: booleanWhether this timeschedule is valid on a Monday between start and end datetimes
: "boolean",
"tuesday"tuesday
type: booleanWhether this timeschedule is valid on a Tuesday between start and end datetimes
: "boolean",
"wednesday"wednesday
type: booleanWhether this timeschedule is valid on a Wednesday between start and end datetimes
: "boolean",
"thursday"thursday
type: booleanWhether this timeschedule is valid on a Thursday between start and end datetimes
: "boolean",
"friday"friday
type: booleanWhether this timeschedule is valid on a Friday between start and end datetimes
: "boolean",
"saturday"saturday
type: booleanWhether this timeschedule is valid on a Saturday between start and end datetimes
: "boolean",
"sunday"sunday
type: booleanWhether this timeschedule is valid on a Sunday between start and end datetimes
: "boolean",
"start_time"start_time
type: string, format: date-spanThe 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-spanThe 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-timeThe date at which the timeschedule starts beeing valid
: "string",
"end_date"end_date
type: string, format: date-timeThe date at which the timeschedule stops being valid
: "string"
}
]
},
"tag_id"tag_id
type: string, format: uuidTag assigned to the User. If user already has a tag, this property will be ignored
: "string",
"alias"alias
type: stringAlias of pod guest's site user
: "string",
"first_name"first_name
type: stringUser's First Name
: "string",
"last_name"last_name
type: stringUser's Last Name
: "string",
"email"User's Email
: "string"
}
],
"remove_guests_ids"remove_guests_ids
type: arrayList of Guest to be removed from the Pod. If no Guest exists in the Pod by id, id will be ignored. This Id is PodGuest.Id
: [
"string"
]
}