• 5.2

Update User

Changes a user's password, system status (i.e., disabled or active), and skills.

Request

URL

http[s]://<host>/configapi/v2/user/<login_id>

For example:

http://example.com/configapi/v2/user/lisa.simpson

HTTP Method

PUT

Content-Type

application/json

Parameters

Parameter	Data-Type	Description	Example
password	string	The user password	"ChangeMe"
disabled	Boolean	Whether the user is disabled ("true") or active ("false") in the system	false
changePassword	string	Whether the user must change password ("true") on next login or not ("false")	"false"
skills	object	The skills and percentage values assigned to the user	"Customer Service"

Example Request Body Content

  {
  "password": "top secret",
  "disabled": false,
  "changePassword": true,
  "skills": {
   "Maintenance Renewal": 100,
   "English": 33}
  }

Response

In response to a successful request, the user's properties are updated with the provided parameters, and user data is retrieved.

Verify the updates in either the response data or in Contact Center Administrator > Users & Teams > Users.

Example Response

 {
 "disabled":false,
 "changePassword":false,
 "skills":{},
 "loginId":"lisa.simpson",
 "firstName":"lisa",
 "lastName":"simpson",
 "team":"Customer Service",
 "extension":"1027",
 "email":"lisa.simpson@brightpattern.com",
 "roles":["Agent"]
 }

< Previous