Creates a new user
Request Information
URI Parameters :
None.
Body Parameters :
userName | Description | Type | Additional information |
---|---|---|---|
id |
Primary Key |
globally unique identifier |
Required |
db_language_id |
Foreign key of db_language |
globally unique identifier | |
username |
Username of the user, normally his email address |
string |
Required Max length: 255 |
firstname |
Firstname of the user |
string |
Max length: 255 |
lastname |
Lastname of the user |
string |
Required Max length: 255 |
code |
The Id/Ref of the back office. Used by Embedded entity |
string |
Max length: 50 |
archived |
Archive the user if he is not valid anymore (user cannot be deleted) |
boolean | |
disabled |
Disable temporaly the user (cannot log on) |
boolean | |
emergency_contact |
HR : Person to contact in case of emergency (wife,husband) |
string |
Max length: 64 |
bankaccount |
HR : Bank Account |
string |
Max length: 50 |
social_security |
HR : Social Security Number |
string |
Max length: 50 |
place_of_birth |
HR : place of birth |
string |
Max length: 255 |
nationality |
HR : nationality of the user |
string |
Max length: 255 |
functions |
HR : Functions of the user (Manager, Tech leader) |
string |
Max length: 255 |
birthdate |
HR : Birthdate of the user |
date | |
skype |
Skype name |
string |
Max length: 50 |
notes |
Internal notes/remarks |
string | |
sales_organization_id |
Main organization of the user |
globally unique identifier |
Optionally required : sales_organization_id, sales_organization_code or sales_organization must be provided |
sales_organization |
Embedded entity "sales_organization" when adding/updating user |
sales_organization |
Optionally required : sales_organization_id, sales_organization_code or sales_organization must be provided |
sales_organization_code |
Embedded entity "sales_organization" using ERP PK when adding/updating user |
string |
Optionally required : sales_organization_id, sales_organization_code or sales_organization must be provided |
is_team_leader |
Specify if this user can be used as a team leader |
boolean | |
team_leader_user_id |
Specify his team leader if this user is a team member |
globally unique identifier | |
Email of the user |
string |
Required Max length: 255 |
|
phone |
Phone number of the user |
string |
Max length: 50 |
fax |
Fax number of the user |
string |
Max length: 50 |
mobile |
Mobile number of the user |
string |
Max length: 50 |
private_email |
Private Email of the user |
string |
Max length: 250 |
private_phone |
Private Phone number of the user |
string |
Max length: 50 |
private_fax |
Private Fax number of the user |
string |
Max length: 50 |
private_mobile |
Private Mobile number of the user |
string |
Max length: 50 |
private_street |
Private Address:Street |
string |
Max length: 50 |
private_street_number |
Private Address:Street Number |
string |
Max length: 50 |
private_city |
Private Address:City |
string |
Max length: 50 |
private_zip |
Private Address:Zip |
string |
Max length: 50 |
private_db_country_id |
Private Address:Country |
globally unique identifier | |
private_db_country_code |
Private Address:CountryCode entity using international code when adding/updating user |
string | |
modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date | |
allow_hero_app |
Specify if this user has priviliages to hero app |
boolean | |
allow_sales_app |
Specify if this user has priviliages to salse app |
boolean | |
allow_service_app |
Specify if this user has priviliages to service app |
boolean | |
user_group_id |
Specify the user group that user belongs to |
globally unique identifier |
Request Formats :
application/json, text/json
{ "id": "91b5fa74-ce3d-4ed6-88e6-e0100f36759a", "db_language_id": "48a59e20-228b-4b87-b6d4-ed06f4fddc39", "username": "sample string 3", "firstname": "sample string 4", "lastname": "sample string 5", "code": "sample string 6", "archived": true, "disabled": true, "emergency_contact": "sample string 9", "bankaccount": "sample string 10", "social_security": "sample string 11", "place_of_birth": "sample string 12", "nationality": "sample string 13", "functions": "sample string 14", "birthdate": "2025-07-06T07:05:34.2588073+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "778244e2-8742-403c-b351-8946fff7ac9d", "sales_organization": { "id": "d2ec35f6-51f5-4202-908d-c3fc04ada603", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "13cdaca2-f068-4b6e-a470-4c4d0d54ce7e", "db_currency_id": "8f62e27e-963e-40c9-83f8-7a545a674559", "db_language_id": "d5c327c5-f0df-4e9e-a4bd-84211bb59d38", "accountancy_code": "sample string 8", "archived": true, "default_unit_of_measure_system_type": "sample string 10", "street": "sample string 11", "street2": "sample string 12", "street_number": "sample string 13", "zip": "sample string 14", "city": "sample string 15", "email": "sample string 16", "phone": "sample string 17", "fax": "sample string 18", "url": "sample string 19", "vat_reg_code": "sample string 20", "modified_dateutc": "2025-07-06T07:05:34.2588073+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "886a8b6b-6a5a-4fbe-8175-c302199ce53c", "email": "sample string 22", "phone": "sample string 23", "fax": "sample string 24", "mobile": "sample string 25", "private_email": "sample string 26", "private_phone": "sample string 27", "private_fax": "sample string 28", "private_mobile": "sample string 29", "private_street": "sample string 30", "private_street_number": "sample string 31", "private_city": "sample string 32", "private_zip": "sample string 33", "private_db_country_id": "7fa225b3-5077-4918-8488-9caac1d10807", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-07-06T07:05:34.2588073+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "6946f65d-7afe-4172-8a96-da1cb9c4607e" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.