Add/Invite a user

This endpoint allows to add a new user per site. Email and phone is optional but required if the user has remote opening privilege. A tag is required if the user has offline access privilege.

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}/users
Method: POST
Parameters:
path {
site_id
type: string

Id of the site

site_id
} (string)

Body (application/json):
{

"first_name"
first_name
type: string

The first name of the user, only editable if it has no profile.

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

The last name of the user, only editable if it has no profile.

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

The email of the user, only editable if it has no profile. This will result in an invite to create a profile.

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

Tag Id of the user

: "string",
"role_ids"
role_ids
type: array

The roles assigned to the user. Must contain at least one hierarchical role

: [
"string"
],
"alias"
alias
type: string

The alias label for the site user

: "string",
"toggle_easy_office_mode"
toggle_easy_office_mode
type: boolean

Indicates if the user can toggle easy office mode

: "boolean",
"toggle_manual_office_mode"
toggle_manual_office_mode
type: boolean

Indicates if the user can toggle manual office mode

: "boolean",
"blocked"
blocked
type: boolean

Indicates if the user is blocked in this site

: "boolean",
"override_privacy_mode"
override_privacy_mode
type: boolean

Indicates if user can override privacy mode in this site, false by default

: "boolean",
"use_pin"
use_pin
type: boolean

Indicates if the user is able to use pin in this site

: "boolean"

}
App storePlay store