Update a User

Lets you update a user –

  • Pass the UserId in the query string.
  • Pass the SchemaName and Value of the attributes you want to update.

You can update the following user attributes –

Address,AssociatedPhoneNumbers, AvailabilityStatus, City, Country, DateFormat, DeletionStatusCode, Department, Designation, FirstName, HolidayCalendarId, IsEmailSender, IsPhoneCallAgent, IsWorkingToday, LastName, MiddleName, mx_Custom_1, mx_Custom_2, mx_Custom_3, mx_Custom_4, mx_Custom_5, mx_Custom_6, mx_Custom_7, mx_Custom_8, mx_Custom_9, mx_Custom_10, OfficeLocationName, PhoneMain, PhoneOthers, Role, SalesRegions, Signature_Html, Signature_Text, Skills, State, Team, TeamId, TelephonyAgentId, TemplateNames, TimeZone, UserType, WorkDayTemplateId, ZipCode

 

You can update the following user settings –

IgnoreIPRestrictionForLogin, RestrictMobileLogin, IsSoftPhoneEnabled, ApplyOnlyUserSpecificPT, AllowUpdatingManagerInHierarchy

API URL

POST
https://{host}/v2/UserManagement.svc/User/Update?accessKey=AccessKey&secretKey=SecretKey&UserId=User Id
Copy URL

URL Parameters

Parameter Description
User Id Unique identifier of the user.

Request

JSON Body/Payload

Content-Type: application/json

{
   "user":{
      "LastName":"Kant",
      "AssociatedPhoneNumbers":"+91-999999999"
   },
   "userSettings":{
      "IsSoftPhoneEnabled":1,
      "ApplyOnlyUserSpecificPT":1,
      "IgnoreIPRestrictionForLogin":0,
      "RestrictMobileLogin":1,
      "AllowUpdatingManagerInHierarchy":0
   }
}

JSON Properties

Parameter Description
User

Object where you can pass the user parameters you want to update along with the updated values.

UserSettings

You can pass the following user settings as either ‘0’ for disabled or ‘1’ for enabled.

  • IgnoreIPRestrictionForLogin – This will ignore IP restrictions configured in your account for user login.
  • RestrictMobileLogin – This will restrict users from logging in from their mobile apps.
  • IsSoftPhoneEnabled – Enables Softphone for your users.
  • ApplyOnlyUserSpecificPT – Applies only user-specific permission templates.
  • AllowUpdatingManagerInHierarchy – Users will be available under user hierarchy UI, where the reporting manager can be changed. To know more, see Manage Users.

Response

200 OK

Content-Type: application/json

{
    "Status": "Success",
    "ExceptionMessage": ""
}

HTTP Response Code

Code Description
200 OK

This is the status code for successful API call.

401 Unauthorized

The API call was made with invalid access credentials. Check your AccessKey and SecretKey.

400 Bad Request

The message body on the request is not as per API specification. Make sure that content type is set to “application/json” and the JSON body has correct attribute names and structure.

404 Not Found

The API could not be found. Please check the API signature.

429 Too Many Requests

API calls exceeded the limit of 25 in 5 second(s)

500 Internal Server Error

The API called failed. There could be many reasons for it. Check the exception message to get more details.