Create User

Required permissions: users.create.*

Authorizations

X-Access-Key-Id

string

headerrequired

X-Access-Key-Secret

string

headerrequired

Body

application/json

department_id

integer

required

first_name

string

required

Maximum length: 255

last_name

string

required

Maximum length: 255

email

string

required

Maximum length: 255

timezone

string

required

In IANA timezone format.

work_hours

object

required

Show child attributes

work_hours.sunday

object[]

required

Show child attributes

work_hours.sunday.start

object

required

A representation of time in a day. Cannot total to more than 24 hours.

Show child attributes

work_hours.sunday.start.hour

integer

required

Required range: 0 < x < 24

work_hours.sunday.start.minute

integer

required

Required range: 0 < x < 60

work_hours.sunday.start.second

integer

required

Required range: 0 < x < 60

work_hours.sunday.end

object

required

A representation of time in a day. Cannot total to more than 24 hours.

Show child attributes

work_hours.sunday.end.hour

integer

required

Required range: 0 < x < 24

work_hours.sunday.end.minute

integer

required

Required range: 0 < x < 60

work_hours.sunday.end.second

integer

required

Required range: 0 < x < 60

work_hours.monday

object[]

required

Show child attributes

work_hours.monday.start

object

required

A representation of time in a day. Cannot total to more than 24 hours.

Show child attributes

work_hours.monday.start.hour

integer

required

Required range: 0 < x < 24

work_hours.monday.start.minute

integer

required

Required range: 0 < x < 60

work_hours.monday.start.second

integer

required

Required range: 0 < x < 60

work_hours.monday.end

object

required

A representation of time in a day. Cannot total to more than 24 hours.

Show child attributes

work_hours.monday.end.hour

integer

required

Required range: 0 < x < 24

work_hours.monday.end.minute

integer

required

Required range: 0 < x < 60

work_hours.monday.end.second

integer

required

Required range: 0 < x < 60

work_hours.tuesday

object[]

required

Show child attributes

work_hours.tuesday.start

object

required

A representation of time in a day. Cannot total to more than 24 hours.

Show child attributes

work_hours.tuesday.start.hour

integer

required

Required range: 0 < x < 24

work_hours.tuesday.start.minute

integer

required

Required range: 0 < x < 60

work_hours.tuesday.start.second

integer

required

Required range: 0 < x < 60

work_hours.tuesday.end

object

required

A representation of time in a day. Cannot total to more than 24 hours.

Show child attributes

work_hours.tuesday.end.hour

integer

required

Required range: 0 < x < 24

work_hours.tuesday.end.minute

integer

required

Required range: 0 < x < 60

work_hours.tuesday.end.second

integer

required

Required range: 0 < x < 60

work_hours.wednesday

object[]

required

Show child attributes

work_hours.wednesday.start

object

required

A representation of time in a day. Cannot total to more than 24 hours.

Show child attributes

work_hours.wednesday.start.hour

integer

required

Required range: 0 < x < 24

work_hours.wednesday.start.minute

integer

required

Required range: 0 < x < 60

work_hours.wednesday.start.second

integer

required

Required range: 0 < x < 60

work_hours.wednesday.end

object

required

A representation of time in a day. Cannot total to more than 24 hours.

Show child attributes

work_hours.wednesday.end.hour

integer

required

Required range: 0 < x < 24

work_hours.wednesday.end.minute

integer

required

Required range: 0 < x < 60

work_hours.wednesday.end.second

integer

required

Required range: 0 < x < 60

work_hours.thursday

object[]

required

Show child attributes

work_hours.thursday.start

object

required

A representation of time in a day. Cannot total to more than 24 hours.

Show child attributes

work_hours.thursday.start.hour

integer

required

Required range: 0 < x < 24

work_hours.thursday.start.minute

integer

required

Required range: 0 < x < 60

work_hours.thursday.start.second

integer

required

Required range: 0 < x < 60

work_hours.thursday.end

object

required

A representation of time in a day. Cannot total to more than 24 hours.

Show child attributes

work_hours.thursday.end.hour

integer

required

Required range: 0 < x < 24

work_hours.thursday.end.minute

integer

required

Required range: 0 < x < 60

work_hours.thursday.end.second

integer

required

Required range: 0 < x < 60

work_hours.friday

object[]

required

Show child attributes

work_hours.friday.start

object

required

A representation of time in a day. Cannot total to more than 24 hours.

Show child attributes

work_hours.friday.start.hour

integer

required

Required range: 0 < x < 24

work_hours.friday.start.minute

integer

required

Required range: 0 < x < 60

work_hours.friday.start.second

integer

required

Required range: 0 < x < 60

work_hours.friday.end

object

required

A representation of time in a day. Cannot total to more than 24 hours.

Show child attributes

work_hours.friday.end.hour

integer

required

Required range: 0 < x < 24

work_hours.friday.end.minute

integer

required

Required range: 0 < x < 60

work_hours.friday.end.second

integer

required

Required range: 0 < x < 60

work_hours.saturday

object[]

required

Show child attributes

work_hours.saturday.start

object

required

A representation of time in a day. Cannot total to more than 24 hours.

Show child attributes

work_hours.saturday.start.hour

integer

required

Required range: 0 < x < 24

work_hours.saturday.start.minute

integer

required

Required range: 0 < x < 60

work_hours.saturday.start.second

integer

required

Required range: 0 < x < 60

work_hours.saturday.end

object

required

A representation of time in a day. Cannot total to more than 24 hours.

Show child attributes

work_hours.saturday.end.hour

integer

required

Required range: 0 < x < 24

work_hours.saturday.end.minute

integer

required

Required range: 0 < x < 60

work_hours.saturday.end.second

integer

required

Required range: 0 < x < 60

role

string

required

Must be an existing Role name.

activate

boolean

default: false

Required permissions: users.lock.*. If true, User's status is automatically activated. Must be true is is_silent if true.

is_silent

boolean

default: false

If true, no invitation email is sent.

Response

200 - application/json

message

string

required

data

object

required

A User resource object.

Show child attributes

data.id

integer

required

data.department_id

integer

required

data.first_name

string

required

Maximum length: 255

data.last_name

string

required

Maximum length: 255

data.email

string

required

Maximum length: 255

data.timezone

string

required

In IANA timezone format.

data.work_hours

object

required

Show child attributes

data.work_hours.sunday

object[]

required

Show child attributes

data.work_hours.sunday.start

object

required

A representation of time in a day. Cannot total to more than 24 hours.

Show child attributes

data.work_hours.sunday.start.hour

integer

required

Required range: 0 < x < 24

data.work_hours.sunday.start.minute

integer

required

Required range: 0 < x < 60

data.work_hours.sunday.start.second

integer

required

Required range: 0 < x < 60

data.work_hours.sunday.end

object

required

A representation of time in a day. Cannot total to more than 24 hours.

Show child attributes

data.work_hours.sunday.end.hour

integer

required

Required range: 0 < x < 24

data.work_hours.sunday.end.minute

integer

required

Required range: 0 < x < 60

data.work_hours.sunday.end.second

integer

required

Required range: 0 < x < 60

data.work_hours.monday

object[]

required

Show child attributes

data.work_hours.monday.start

object

required

A representation of time in a day. Cannot total to more than 24 hours.

Show child attributes

data.work_hours.monday.start.hour

integer

required

Required range: 0 < x < 24

data.work_hours.monday.start.minute

integer

required

Required range: 0 < x < 60

data.work_hours.monday.start.second

integer

required

Required range: 0 < x < 60

data.work_hours.monday.end

object

required

A representation of time in a day. Cannot total to more than 24 hours.

Show child attributes

data.work_hours.monday.end.hour

integer

required

Required range: 0 < x < 24

data.work_hours.monday.end.minute

integer

required

Required range: 0 < x < 60

data.work_hours.monday.end.second

integer

required

Required range: 0 < x < 60

data.work_hours.tuesday

object[]

required

Show child attributes

data.work_hours.tuesday.start

object

required

A representation of time in a day. Cannot total to more than 24 hours.

Show child attributes

data.work_hours.tuesday.start.hour

integer

required

Required range: 0 < x < 24

data.work_hours.tuesday.start.minute

integer

required

Required range: 0 < x < 60

data.work_hours.tuesday.start.second

integer

required

Required range: 0 < x < 60

data.work_hours.tuesday.end

object

required

A representation of time in a day. Cannot total to more than 24 hours.

Show child attributes

data.work_hours.tuesday.end.hour

integer

required

Required range: 0 < x < 24

data.work_hours.tuesday.end.minute

integer

required

Required range: 0 < x < 60

data.work_hours.tuesday.end.second

integer

required

Required range: 0 < x < 60

data.work_hours.wednesday

object[]

required

Show child attributes

data.work_hours.wednesday.start

object

required

A representation of time in a day. Cannot total to more than 24 hours.

Show child attributes

data.work_hours.wednesday.start.hour

integer

required

Required range: 0 < x < 24

data.work_hours.wednesday.start.minute

integer

required

Required range: 0 < x < 60

data.work_hours.wednesday.start.second

integer

required

Required range: 0 < x < 60

data.work_hours.wednesday.end

object

required

A representation of time in a day. Cannot total to more than 24 hours.

Show child attributes

data.work_hours.wednesday.end.hour

integer

required

Required range: 0 < x < 24

data.work_hours.wednesday.end.minute

integer

required

Required range: 0 < x < 60

data.work_hours.wednesday.end.second

integer

required

Required range: 0 < x < 60

data.work_hours.thursday

object[]

required

Show child attributes

data.work_hours.thursday.start

object

required

A representation of time in a day. Cannot total to more than 24 hours.

Show child attributes

data.work_hours.thursday.start.hour

integer

required

Required range: 0 < x < 24

data.work_hours.thursday.start.minute

integer

required

Required range: 0 < x < 60

data.work_hours.thursday.start.second

integer

required

Required range: 0 < x < 60

data.work_hours.thursday.end

object

required

A representation of time in a day. Cannot total to more than 24 hours.

Show child attributes

data.work_hours.thursday.end.hour

integer

required

Required range: 0 < x < 24

data.work_hours.thursday.end.minute

integer

required

Required range: 0 < x < 60

data.work_hours.thursday.end.second

integer

required

Required range: 0 < x < 60

data.work_hours.friday

object[]

required

Show child attributes

data.work_hours.friday.start

object

required

A representation of time in a day. Cannot total to more than 24 hours.

Show child attributes

data.work_hours.friday.start.hour

integer

required

Required range: 0 < x < 24

data.work_hours.friday.start.minute

integer

required

Required range: 0 < x < 60

data.work_hours.friday.start.second

integer

required

Required range: 0 < x < 60

data.work_hours.friday.end

object

required

A representation of time in a day. Cannot total to more than 24 hours.

Show child attributes

data.work_hours.friday.end.hour

integer

required

Required range: 0 < x < 24

data.work_hours.friday.end.minute

integer

required

Required range: 0 < x < 60

data.work_hours.friday.end.second

integer

required

Required range: 0 < x < 60

data.work_hours.saturday

object[]

required

Show child attributes

data.work_hours.saturday.start

object

required

A representation of time in a day. Cannot total to more than 24 hours.

Show child attributes

data.work_hours.saturday.start.hour

integer

required

Required range: 0 < x < 24

data.work_hours.saturday.start.minute

integer

required

Required range: 0 < x < 60

data.work_hours.saturday.start.second

integer

required

Required range: 0 < x < 60

data.work_hours.saturday.end

object

required

A representation of time in a day. Cannot total to more than 24 hours.

Show child attributes

data.work_hours.saturday.end.hour

integer

required

Required range: 0 < x < 24

data.work_hours.saturday.end.minute

integer

required

Required range: 0 < x < 60

data.work_hours.saturday.end.second

integer

required

Required range: 0 < x < 60

data.role

string

required

Must be an existing Role name.

data.created_at

string

required

data.updated_at

string

required

data.status

enum<integer>

*0 - Invited *1 - Active *2 - Locked

Available options:

0,

1,

2

data.avatar_url

string

data.name

string

data.department_name

string

data.deleted_at

string | null