Update User

API Documentation

Update User

The Put User API updates user details in the LMSSuccess

Endpoint:

Put /
/api/v1/User

Request Parameters

Id Int (Required)

The Id of the user.

UserName String (Required)

The user’s username (used during sign-in). Email address can be used as long as it is unique within the system. Note: even if the user will be using an external authentication provider, the username/password properties should still be provided.

Password String (Required)

The user’s password (used during sign-in). Note: even if the user will be using an external authentication provider, the username/password properties should still be provided. The user will be prompted to reset their password on the next signin.

Email String (Required)

The user’s e-mail address

FirstName String (Required)

The user’s First name.

LastName String (Required)

The user’s last name

Phone String (Optional)

The user’s phone number

ExternalId String (Optional)

The user’s external ID, usually a unique identifier from the calling system

MiddleName String (Optional)

The user’s middle name

Title String (Optional)

The user’s title.

CompanyId Int (Optional)

The Id of the user’s company (set only if the user belongs to a company)

CompanyId Int (Optional)

The user Id of the user’s manager (set only if the user belongs to a manager)

Disabled Boolean (Optional)

Indicates whether the user account has been disabled

Phone2 String (Optional)

The user’s secondary phone number

Address String (Optional)

First line of the user’s address

Address2 String (Optional)

Second line of the user’s address

City String (Optional)

The user’s city

State String (Optional)

The user’s state

Country String (Optional)

The user’s country

Zip String (Optional)

The user’s zip/postal code

SecondaryEmail String (Optional)

The user’s secondary e-mail address

				
					{
  "FirstName": "tom",
  "LastName": "apres",
  "UserName": "tom.apris",
  "ExternalId": null,
  "Address1": "2244 Walnut Grove Go1",
  "Address2": "2244 Walnut Grove towa",
  "City": "Rosemead",
  "State": "CA",
  "Country": null,
  "Zip": "91770",
  "CompanyId": 140594,
  "Disabled": false,
  "Email": "tom.vani@sce.com",
  "SecondaryEmail": "apres.tom76@sce.com",
  "ManagerId": 1805846,
  "MiddleName": null,
  "Phone": "(626) 302-1212",
  "Phone2": null,
  "Title": null,
  "Password": "Password@123"
}

Response

Success Boolean(Nullable)

Indicates the status of the API request

Message String(Nullable)

Success or failure message

Data Null(Nullable)
				
					{
  "success": true,
  "message": "Record updated successfully.",
  "data": null
}