Update a User - PUT /Users/{id}

Update user details according to User Id.

Usage:

1. GET /Users/{id} and get details of a user
2. PUT /Users/{id} and update user details

URL

/cxrestapi/auth/Users/{id}

Method:

PUT

Media Type (header):

Authorization: Bearer <access token value>
Content-Type: application/json;v=1.0

Parameters

Required:

id=[integer] - Unique Id of the User

updateUserModel=[body]: Specifies the user details to update
roleIds=[integer] - User related role(s) Id(s)
teamIds=[integer] - User related team(s) Id(s)
firstName=[string] - User first name
lastName=[string] – User last name
email=[string] - User email address
phoneNumber=[string] - User phone number
cellPhoneNumber=[string] - User cellular phone number
jobTitle=[string] - User job title
other=[string] - User other information
country=[boolean] - User country
active=[string] – User active/inactive state (true/false)
expirationDate=[string] – User expiration date (date-time)
allowedIpList=[string] - User allowed IPs
localeId=[integer] - User locale

Success Response:

Code: 204 Success

Error Response:

Code: 400 Bad Request
Code: 401 Unauthorized
Code: 403 Forbidden
Code: 404 Not Found

Sample Response:

no content

Notes:

Updates the user details according to the defined parameters. Once the request is successful, it does not return any content. If the request fails, it returns an error response.

Send Documentation Feedback - If you have comments about this documentation, you can contact the documentation team by sending your feedback to us. We appreciate your feedback!