Function name
create-users
Parameters
- data (Required). It is an array of fields. The details of the fields are as follows :
name (Required). String. Either the first, last name or both must be present.
login (Optional). String. Login name of the user. If login is present, the user will be counted towards your license count.
password (Optional). String. Password of the user.
email (Optional). String. Email of the user. For users with login, email is mandatory.
role_ids (Optional). String. A comma separated string of role ids.
workspace_id(Optional). The name or ID of the workspace where the new user is to be created.
is_admin (Optional). A Boolean value: True or False(not an admin user) .
bill_rate(Optional). A decimal value specifying the billing rate of the new user.
cost_rate (Optional). A decimal value specifying the cost rate of the new user.
phone(Optional). A numeric value.
calendar_id(Optional). The name or ID of the work calendar with which the new user is to be created.
keywords(Optional). String
Return values
user_id
When your data format is XML, you should post something like this:
<data>
<item>
<name>Joe Cole</name>
<login>joe.cole</login>
<password>kaboom1</password>
<email>joe.cole@celoxis.com</email>
<role_ids>1738,1912</role_ids>
<client_ref_no>AIQ_87</client_ref_no> <!-- Custom field attached to client>
</item>
<item>
<name>Mary Jane</name>
<login>mary.jane</login>
<password>krypton2</password>
<email>mary.jane@celoxis.com</email>
<role_ids>1738</role_ids>
</item>
</data>
In case of JSON, you should submit an array of objects with the same properties.
[
{
"name":"Joe Cole",
"login":"joe.cole",
"password":"kaboom1",
"email":"joe.cole@celoxis.com"
"client_ref_no":"AIQ_87" <!-- Custom field attached to client>
}
{
"name":"Mary Jane",
"login":"mary.jane",
...
}
]