POST
/v2/user/add
Use this API call to add a new user to a particular company. Note, that only users with the roles of manager, customer care and accounting can be added with this call. A user with the role of an account owner is created using the addCompany call as part of the Company partner controller.
Parameters
Name
Description
userAddUpdate
(required)
This model allows you to specify all parameters required for the creation of the user under a particular company. For more details follow the body schema as described in the details of this call.
Response Messages
Code
Description
200
OK
201
Created
401
Unauthorized
403
Forbidden
404
Not Found
{
"account_title": "string",
"address": {
"id": 0,
"zip": "string",
"city": "string",
"country": 0,
"province": 0,
"address": "string",
"selected": true
},
"address_same_as_company": true,
"date_of_birth": "yyyy-MM-dd",
"email": "string",
"first_name": "string",
"last_name": "string",
"logo": "string",
"owner_ship": 1.01,
"password": "string",
"phone": "string",
"role": "ACCOUNT_OWNER",
"send_email": true,
"ssn": "string",
"state": "ACTIVE",
"time_zone_id": "string",
"user_code": "string"
}
{ } UserAddUpdateV2Model
account_title
optional
string
address_same_as_company
optional
boolean
date_of_birth
optional
string
email
optional
string
first_name
optional
string
last_name
optional
string
logo
optional
string
owner_ship
optional
number
password
optional
string
phone
optional
string
role
optional
string
send_email
optional
boolean
ssn
optional
string
state
optional
string
time_zone_id
optional
string
user_code
optional
string
{ } AddressApiV2Model
id
optional
integer
zip
optional
string
city
optional
string
country
optional
integer
province
optional
integer
address
optional
string
selected
optional
boolean
<user_add_update_model>
<account_title>string</account_title>
<address/>
<address_same_as_company>1</address_same_as_company>
<date_of_birth>yyyy-MM-dd</date_of_birth>
<email>string</email>
<first_name>string</first_name>
<last_name>string</last_name>
<logo>string</logo>
<owner_ship>1.01</owner_ship>
<password>string</password>
<phone>string</phone>
<role>ACCOUNT_OWNER</role>
<send_email>1</send_email>
<ssn>string</ssn>
<state>ACTIVE</state>
<time_zone_id>string</time_zone_id>
<user_code>string</user_code>
</user_add_update_model>
{ } UserAddUpdateV2Model
account_title
optional
string
address_same_as_company
optional
boolean
date_of_birth
optional
string
email
optional
string
first_name
optional
string
last_name
optional
string
logo
optional
string
owner_ship
optional
number
password
optional
string
phone
optional
string
role
optional
string
send_email
optional
boolean
ssn
optional
string
state
optional
string
time_zone_id
optional
string
user_code
optional
string
{ } AddressApiV2Model
id
optional
integer
zip
optional
string
city
optional
string
country
optional
integer
province
optional
integer
address
optional
string
selected
optional
boolean