Skip to main content

User account attributes

email
string<email>
required

User email address (used for login)

role_id
integer
required

Role ID determining user permissions

name
string | null

User display name

user_type
enum<string> | null

Type of user access

Available options:
api,
web,
account
is_active
boolean | null

If false, user cannot log in

language
string | null

Preferred language code

timezone
string | null

Preferred timezone

external_system_reference1
string | null

External system reference 1

external_system_reference2
string | null

External system reference 2

external_system_reference3
string | null

External system reference 3

string1
string | null

Custom string field 1

string2
string | null

Custom string field 2

string3
string | null

Custom string field 3

string4
string | null

Custom string field 4

string5
string | null

Custom string field 5