User APIs

Add User

OVERVIEW

This API call is used to add a new user to the system.

Note:

1. Added support for the following new fields

emaildomain, org, invitationsent, createdby, createddate, modifiedby, modifieddate, ifpartner, lastlogindate, invalidlogins, externalid, publicwebsiteprofileid, systemuser, resetpassworddate, usertypeid, avatar, practicegroup, langcode, publicprofile, dateOfBirth

2. Address tag has been added in API version 4

<address>
<addressid>1</addressid>
</address
 

HTTP Request

POST   /api/3/users

 

Request object

User request object

HTTP Response

Success

HTTP response 200

 

XML response

 

 

<user>
    <userid>13</userid>
    <firstname>qwe</firstname>
    <lastname>qwe</lastname>
    <link>http://example.com/context/api/3/users/13</link>
</user>

 

JSON response

 

{
    "userid": "12"
    "firstname": "Tom",
"lastname": "Chick",
    "link": "http://example.com/context/api/3/users/12"
}

 

Error messages

 

Summary Ref Code (before V4) Ref Code (V4)
Email address is required 101 101
Invalid email address 104 104
First name is required 102 102
Maximum allowed characters for the first name must be between 1 to 100 102 352
The secretary's email address is not valid 104 353
Status must be active or inactive 116 116
The entered department cannot be more than 256 characters N/A 354
The entered ifpartner attribute is invalid N/A 355
The entered systemuser attribute is invalid N/A 356
The entered usertypeid attribute is invalid N/A 357
The entered langcode attribute is invalid N/A 358
The entered sourcetype attribute is invalid.Valid values are System, Active directory or System default . N/A 359
Please enter valid phone number    N/A 360
Please enter valid phone number in format {countrycode}  ${areacode}${number}. N/A 361
Please enter valid mobile number in format {countrycode}${number}. N/A 362
Enter a valid office phone country code N/A 363
The office phone country code can have a maximum of 4 digits N/A 364
Enter a valid office phone area code N/A 365
The office phone area code can have a maximum of 5 Digits N/A 366
Office phone number should have maximum of 15 digits N/A 368
Enter a valid mobile phone country code N/A 369
The mobile phone country code can have a maximum of 4 Digits N/A 372
Please enter a valid mobile number N/A 373
Mobile phone number should have maximum of 20 digits N/A 374
Domain does not exist 105 105
Email already exists in the system 111 111
Mention organisation in case of self registered domain    187 187
Mention organisation in case of exceptional domain    115 115
Org id is not in the proper format    112 112
Organisation does not exist 106 106
Domain exist in other organisation 114 114
Entered Address Id is not valid N/A 308
Social link name not found in system. N/A 375
The social link name is required N/A 376
The social link value is required N/A 377
Maximum characters for social link value must be between 1 to 500 N/A 378
Enter the name for the custom link N/A 379
The custom link value required N/A 380
Max characters for custom link name must be between 1 to 500 N/A 381
Max characters for custom link value must be between 1 to 500 N/A 382
The message link name required N/A 383
Message link name not found in system N/A 384
The message link value required    N/A 385
Max characters for message link value must be between 1 to 500 N/A 386
The social link is disabled N/A 408
The message link is disabled N/A 409
The custom link is disabled N/A 410


 

Comments


3 Comments


Is it possible only to have this "passive" / receiving API or can the collaborate alternatively query data from customers' systems and create accounts internally? Plus, what kind of format would be required? The same 'User request object' ? Cheers


It is important to mention, that when adding a user via this API call, the user will be sent an invitation automatically.

If you dont want the user to be send an invitation you should append the querystring of sendinvitation = false.

api/3/sites//users?sendinvitation=false

 

Last Updated: Nov 08,2024