User resource

Update user

OVERVIEW

This API call is used to update an existing user in the system.

Note:

1. Introduced the following fields in the response body 

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

2. Address tag is available from API version 4

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

 

HTTP Request

PUT   /api/4/users/<ID>

 

URL Parameters

 

Parameter Description
ID The ID of the user to retrieve

Example

PUT   http://example.com/context/api/4/users/3

Request object

User request object

 

HTTP Response

Success

HTTP response 200

Error

See  API Error messages 

Summary Ref Code (before V4) Ref Code (V4)
User id is not in proper format    113 113
User does not exists in the system 110 110
Update user is not applicable in case of self registered user 188 188
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 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


6 Comments


How can I update user avatar(profile pic) via API? what value needs to be pass?


Peter Naylor it is available to update one address to another using the address ID, however you cannot change the address details. Please try and let me know if that is not working for you, and I will raise a bug report for you.


Imran Aziz Thanks, you may want to remove the "2. Address tag is available from API version 4" part from the Update User page!


Peter Naylor the address tag in the user object returns the address information but cannot be used to change it. We are working on the address API which can be used to change the address.

I'm having trouble updating an address for a user. Here is my example data. Is something amiss?


  <user xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <firstname>John</firstname>
  <lastname>Fakename</lastname>
  <email>John@fakename.com</email>
  <org>1879</org>
  <userid>5509</userid>
  <phone>123 456 789</phone>
  <mobile>123 456 789</mobile>
  <jobtitle>Director</jobtitle>
  <address>
    <addressid>2126</addressid>
    <addressline1>a</addressline1>
    <addressline2>a</addressline2>
    <city>test</city>
    <country>test</country>
    <postCode>a</postCode>
    <state>a</state>
  </address>  
</user>

I am calling version 4 of the API and getting response 200 but the address isn't updating.

Last Updated: Nov 08,2024