Skip to main content
POST
Create User

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Attributes pertaining to users

first_name
string
Example:

"Jane"

last_name
string
Example:

"Smith"

primary_email
string
username
string
Example:

"jsmith"

group_id
integer

The id of the group that this user has been placed in and will use to derive their ACL permissions

Example:

9223

timezone
string

Name of the timezone as described in the tz Database

Example:

"Australia/Sydney"

locale
enum<string>

Language that will be used in the Sonderplan interface

Available options:
en_US
Example:

"en_US"

date_format
enum<string>

The date format identifier that dates should be formatted in

Available options:
j/n/y,
d/m/y,
d/m/Y,
n/j/y,
m/d/y,
m/d/Y,
y/n/j,
y/m/d,
Y/m/d
Example:

"d/m/Y"

time_format
enum<string>

The time format that time should be formatted to, 0 = 12 hour time, 1 = 24 hour / military time

Available options:
0,
1
Example:

"1"

notification
boolean

Should notifications be sent to this user

expires
integer

Unix time of when this user will expire and no longer be able to sign in

schedule_view_mode
integer

Applies only if the user is also added as a resource. 0 = Show all bookings, 1 = Anonymize other bookings, 2 = Hide other bookings

Response

Successful Operation

success
object