User resource

Update user - Update user v1

OVERVIEW

This method provides the capability to update an existing user details. User object is required in the body of the PUT request.

Note: We do not support adding and updating location information in the User API, only the get operation returns location information. 

Request

PUT    /Users/{id}

Parameters

 

Parameter Name

Value

Description

id

Int

The ID for the user in question

Request Body

<user >

<firstname>Joe</firstname>

<lastname>Blow</lastname>

<email> joe.blow@domain.com</email>

<phone>+44 (0) 207 1111 0000</phone>

<department>marketing</department>

<org>ORG001</org>

<sociallinks>

        <link>

            <name>LinkedIn</name>

            <value>http://www.linkin.com/tom.chick</value>

        </link>

</sociallinks>

<customlink>

         <link>

            <name>My Web</name>

            <value>http://www.mywebsite.com</value>

        </link>

    </customlink>

    <messaginglink>

        <link>

            <name>Skype</name>

            <value>tom.chick.skype</value>

        </link>

    </messaginglink>

<img>http://imageurl.com/img</img>

<jobtitle>software engineer</jobtitle>

<secretaryname>time of india</secretaryname>

<secretarymail>times@india.com</secretarymail>

<title>Title</title>

<bio>I am from HighQ</bio>

<sourcetype>System</sourcetype>

<specialities>java,dotNet</specialities>

<status>active</status>

<goesby>alpesh.lodhari</goesby>

</user>

Response

If the request is successful an error object is returned with the information similar to the Add User interface otherwise an error object is returned.

 

<error>

            <ref> Error reference code in at which full stack trace can be obtained</ref>

           <summery> Details for the error </summery>

          <atom:link rel="self" href="…/errors/user002" />  // returns the full strack trace and other details for why the error happened

</error>

 

Code Meaning
200 User updated successfully
400

Problem with parsing XML or JSON object (Bad Request)

401 Unauthorized
403 Validation failed/ Forbidden
405 Method not allowed (calling api with wrong method)
500 Internal error occured while creating folder

Comments


3 Comments

Last Updated: Jun 09,2023