Create a user

The user's username (used during sign-in). Email address can be used as long as it is unique within the system. Note: even if the user will be using an external authentication provider, the username/password properties should still be provided.

The user's password (used during sign-in). Note: even if the user will be using an external authentication provider, the username/password properties should still be provided. The user will be prompted to reset their password on the next sign in.

The user's e-mail address

The user's first name

The user's last name

The unique identifier of the organization the user belongs to. This can be the organization that corresponds to your API key, or a child organization.

The user's external ID, usually a unique identifier from the calling system

The user's middle name

The user's title.

The Id of the user's company (set only if the user belongs to a company).

The user Id of the user's manager (set only if the user belongs to a manager).

Indicates whether the user account has been disabled.

The user's phone number.

The user's secondary phone number.

First line of the user's address.

Second line of the user's address

The user's city.

The user's state.

The user's country. The CountryCode field will override this value if both are provided.

The input field, Country, has been deprecated in favor of CountryCode. If the Country field is provided but the CountryCode field is not then CountryCode will be defaulted to OT - Other.
The CountryCode field is a 2-character code for the user's country.

Allowed values

OT Other - The Country field must be provided
AF Afghanistan
AX Åland Islands
AL Albania
DZ Algeria
AS American Samoa
AD Andorra
AO Angola
AI Anguilla
AG Antigua and Barbuda
AR Argentina
AM Armenia
AW Aruba
AU Australia
AT Austria
AZ Azerbaijan
BS Bahamas
BH Bahrain
BD Bangladesh
BB Barbados
BY Belarus
BE Belgium
BZ Belize
BJ Benin
BM Bermuda
BT Bhutan
BO Bolivia
BQ Bonaire, Sint Eustatius and Saba
BA Bosnia and Herzegovina
BW Botswana
BR Brazil
IO British Indian Ocean Territory
VG British Virgin Islands
BN Brunei
BG Bulgaria
BF Burkina Faso
BI Burundi
CV Cabo Verde
KH Cambodia
CM Cameroon
CA Canada
KY Cayman Islands
CF Central African Republic
TD Chad
CL Chile
CN China
CX Christmas Island
CC Cocos (Keeling) Islands
CO Colombia
KM Comoros
CG Congo
CD Congo (DRC)
CK Cook Islands
CR Costa Rica
CI Côte d’Ivoire
HR Croatia
CU Cuba
CW Curaçao
CY Cyprus
CZ Czech Republic
DK Denmark
DJ Djibouti
DM Dominica
DO Dominican Republic
EC Ecuador
EG Egypt
SV El Salvador
GQ Equatorial Guinea
ER Eritrea
EE Estonia
ET Ethiopia
FK Falkland Islands
FO Faroe Islands
FJ Fiji
FI Finland
FR France
GF French Guiana
PF French Polynesia
GA Gabon
GM Gambia
GE Georgia
DE Germany
GH Ghana
GI Gibraltar
GR Greece
GL Greenland
GD Grenada
GP Guadeloupe
GU Guam
GT Guatemala
GG Guernsey
GN Guinea
GW Guinea-Bissau
GY Guyana
HT Haiti
HN Honduras
HK Hong Kong SAR
HU Hungary
IS Iceland
IN India
ID Indonesia
IR Iran
IQ Iraq
IE Ireland
IM Isle of Man
IL Israel
IT Italy
JM Jamaica
JP Japan
JE Jersey
JO Jordan
KZ Kazakhstan
KE Kenya
KI Kiribati
KR Korea
XK Kosovo
KW Kuwait
KG Kyrgyzstan
LA Laos
LV Latvia
LB Lebanon
LS Lesotho
LR Liberia
LY Libya
LI Liechtenstein
LT Lithuania
LU Luxembourg
MO Macao SAR
MK Macedonia, FYRO
MG Madagascar
MW Malawi
MY Malaysia
MV Maldives
ML Mali
MT Malta
MH Marshall Islands
MQ Martinique
MR Mauritania
MU Mauritius
YT Mayotte
MX Mexico
FM Micronesia
MD Moldova
MC Monaco
MN Mongolia
ME Montenegro
MS Montserrat
MA Morocco
MZ Mozambique
MM Myanmar
NA Namibia
NR Nauru
NP Nepal
NL Netherlands
NC New Caledonia
NZ New Zealand
NI Nicaragua
NE Niger
NG Nigeria
NU Niue
NF Norfolk Island
KP North Korea
MP Northern Mariana Islands
NO Norway
OM Oman
PK Pakistan
PW Palau
PS Palestinian Authority
PA Panama
PG Papua New Guinea
PY Paraguay
PE Peru
PH Philippines
PN Pitcairn Islands
PL Poland
PT Portugal
PR Puerto Rico
QA Qatar
RE Réunion
RO Romania
RU Russia
RW Rwanda
BL Saint Barthélemy
KN Saint Kitts and Nevis
LC Saint Lucia
MF Saint Martin
PM Saint Pierre and Miquelon
VC Saint Vincent and the Grenadines
WS Samoa
SM San Marino
ST São Tomé and Príncipe
SA Saudi Arabia
SN Senegal
RS Serbia
SC Seychelles
SL Sierra Leone
SG Singapore
SX Sint Maarten
SK Slovakia
SI Slovenia
SB Solomon Islands
SO Somalia
ZA South Africa
SS South Sudan
ES Spain
LK Sri Lanka
SH St Helena, Ascension, Tristan da Cunha
SD Sudan
SR Suriname
SJ Svalbard and Jan Mayen
SZ Swaziland
SE Sweden
CH Switzerland
SY Syria
TW Taiwan
TJ Tajikistan
TZ Tanzania
TH Thailand
TL Timor-Leste
TG Togo
TK Tokelau
TO Tonga
TT Trinidad and Tobago
TN Tunisia
TR Turkey
TM Turkmenistan
TC Turks and Caicos Islands
TV Tuvalu
UM U.S. Outlying Islands
VI U.S. Virgin Islands
UG Uganda
UA Ukraine
AE United Arab Emirates
GB United Kingdom
US United States
UY Uruguay
UZ Uzbekistan
VU Vanuatu
VE Venezuela
VN Vietnam
WF Wallis and Futuna
YE Yemen
ZM Zambia
ZW Zimbabwe

The user's zip/postal code.

URL to the user's profile image.

The time zone for the data object. If not specified, the timezone of the organization will be used.

Allowed values

Afghanistan Standard Time
Alaskan Standard Time
Aleutian Standard Time
Altai Standard Time
Arab Standard Time
Arabian Standard Time
Arabic Standard Time
Argentina Standard Time
Astrakhan Standard Time
Atlantic Standard Time
AUS Central Standard Time
Aus Central W. Standard Time
AUS Eastern Standard Time
Azerbaijan Standard Time
Azores Standard Time
Bahia Standard Time
Bangladesh Standard Time
Belarus Standard Time
Bougainville Standard Time
Canada Central Standard Time
Cape Verde Standard Time
Caucasus Standard Time
Cen. Australia Standard Time
Central America Standard Time
Central Asia Standard Time
Central Brazilian Standard Time
Central Europe Standard Time
Central European Standard Time
Central Pacific Standard Time
Central Standard Time
Central Standard Time (Mexico)
Chatham Islands Standard Time
China Standard Time
Cuba Standard Time
Dateline Standard Time

5. Africa Standard Time
6. Australia Standard Time
7. Europe Standard Time
8. South America Standard Time
   Easter Island Standard Time
   Eastern Standard Time
   Eastern Standard Time (Mexico)
   Egypt Standard Time
   Ekaterinburg Standard Time
   Fiji Standard Time
   FLE Standard Time
   Georgian Standard Time
   GMT Standard Time
   Greenland Standard Time
   Greenwich Standard Time
   GTB Standard Time
   Haiti Standard Time
   Hawaiian Standard Time
   India Standard Time
   Iran Standard Time
   Israel Standard Time
   Jordan Standard Time
   Kaliningrad Standard Time
   Kamchatka Standard Time
   Korea Standard Time
   Libya Standard Time
   Line Islands Standard Time
   Lord Howe Standard Time
   Magadan Standard Time
   Magallanes Standard Time
   Marquesas Standard Time
   Mauritius Standard Time
   Mid-Atlantic Standard Time
   Middle East Standard Time
   Montevideo Standard Time
   Morocco Standard Time
   Mountain Standard Time
   Mountain Standard Time (Mexico)
   Myanmar Standard Time
9. Central Asia Standard Time
   Namibia Standard Time
   Nepal Standard Time
   New Zealand Standard Time
   Newfoundland Standard Time
   Norfolk Standard Time
   North Asia East Standard Time
   North Asia Standard Time
   North Korea Standard Time
   Omsk Standard Time
   Pacific SA Standard Time
   Pacific Standard Time
   Pacific Standard Time (Mexico)
   Pakistan Standard Time
   Paraguay Standard Time
   Qyzylorda Standard Time
   Romance Standard Time
   Russia Time Zone 10
   Russia Time Zone 11
   Russia Time Zone 3
   Russian Standard Time
   SA Eastern Standard Time
   SA Pacific Standard Time
   SA Western Standard Time
   Saint Pierre Standard Time
   Sakhalin Standard Time
   Samoa Standard Time
   Sao Tome Standard Time
   Saratov Standard Time
   SE Asia Standard Time
   Singapore Standard Time
   South Africa Standard Time
   South Sudan Standard Time
   Sri Lanka Standard Time
   Sudan Standard Time
   Syria Standard Time
   Taipei Standard Time
   Tasmania Standard Time
   Tocantins Standard Time
   Tokyo Standard Time
   Tomsk Standard Time
   Tonga Standard Time
   Transbaikal Standard Time
   Turkey Standard Time
   Turks And Caicos Standard Time
   Ulaanbaatar Standard Time
   US Eastern Standard Time
   US Mountain Standard Time
   UTC
   UTC+12
   UTC+13
   UTC-02
   UTC-08
   UTC-09
   UTC-11
   Venezuela Standard Time
   Vladivostok Standard Time
   Volgograd Standard Time
10. Australia Standard Time
11. Central Africa Standard Time
12. Europe Standard Time
13. Mongolia Standard Time
    West Asia Standard Time
    West Bank Standard Time
    West Pacific Standard Time
    Yakutsk Standard Time
    Yukon Standard Time

An identifier for the role the user should belong to. You can provide multiple instances of this parameter to add the user to multiple roles. For example: roleId=0&roleId=2&roleId=20. You can discover roles available to your API integration by using the GetUserRoles command.

An identifier for the organization the user should have management rights for. You can provide multiple instances of this parameter if the user should have management rights over multiple organizations. For example: managedOrganizationId=30&managedOrganizationId=45&managedOrganizationId=78. All managed organizations must belong to the API caller's organization or one of its children.

An optional parameter to allow the sending of general notifications to the user.

An optional parameter to force the user to change their password on the next login