Add user

User resource

Add user

OVERVIEW

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

HTTP Request

POST /api/3/users

Request object

User request object

Note:

1. Added support for the following new fields to Add user version 1

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 Response

Success

HTTP response 200

Error

See API Error messages

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
Max Character for first name must be between 1 to 100 allowed.	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 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 valid mobile number.	N/A	373
Mobile phone number should have Maximum 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 proper format	112	112
Organisation does not exist	106	106
Domain exist in other organization	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 required	N/A	376
The social link value required	N/A	377
Max Character 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 Character for custom link name must be between 1 to 500	N/A	381
Max Character 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 Character for message link value must be between 1 to 500	N/A	386

Comments

0 Comments

Last Updated: Jun 11,2023