Update User attributes.

Update User Profile attributes such as First Name, Last Name, Friendly Name, Email, Company, Country, Contact, Phone, and User Role. The user role can be updated by sending either role id or role name.

SecurityApiKeyAuth or BasicAuth
Request
path Parameters
id
required
string

Specify a User Profile ID.

header Parameters
X-API-Key
required
string

Customer-specific API key required to invoke API.

Authorization
required
string

Provided by Authentication Token creation operation

AccessToken
required
string

JWT token provided by Authentication Token creation operation.

Request Body schema: application/json
required

The Request Body must be a JSON object

firstName
string

First Name of the user

lastName
string

Last Name of the user

friendlyName
string

Last Name of the user

email
string

Email of the user

company
string

Company name of the user

country
string

Country of the user

contact
number

Contact Number of the user

phone
number

Alternate phone number of the user

userRoleId
string <uuid>

User role id of the user

userRoleName
string

User role name of the user

groups
Array of strings <uuid>

List of user group ids the user is part of

Responses
200

The Response Body will be a JSON object

400

Bad Request, one or more of the required fields are not provided

401

Unauthorized. Missing Authorization or AccessToken or Access Token expired

403

Forbidden. Missing X-API-key

patch/user/{id}
Request samples
application/json
{
  • "firstName": "John",
  • "lastName": "Smith",
  • "friendlyName": "John Smith",
  • "email": "john.smith@company.com",
  • "company": "John's Company Inc.",
  • "country": "USA",
  • "contact": 1234567890,
  • "phone": 1234567890,
  • "userRoleId": "7d5620e0-f423-11e9-8071-89c0c4052141",
  • "userRoleName": "End user",
  • "groups": [
    ]
}
Response samples
application/json
{
  • "userId": "7d675ef0-f423-11e9-8071-89c0c4052141",
  • "customerId": "1234567890",
  • "emailId": "jlake@company.com",
  • "firstName": "John",
  • "lastName": "Lake",
  • "roleId": "7d5620e0-f423-11e9-8071-89c0c4052141",
  • "status": "enabled",
  • "groups": [
    ]
}