Update User

PUT https://{{axpAPIDomain}}/api/admin/user/v1/accounts/:accountId/users/:userId

This API requires the Account Administrator role.

Updates a user.

The following fields must be unique otherwise a HTTP 409 Conflcit will be returned: * userId * emailId

This operation will clear the value stored for any fields not present in the request. For example, to remove a feature such as voice from a user you should omit the voice field in the request. The same behavior applies to every field in the request.

When updating a user with a profileId, the field values in the user request will override any that are also defined in the profile. For example, if the profile contains configuration for features and the user request also contains features, the features defined in the user request will override those from the profile.

Changes to the fields: * roles * features

Will trigger asynchronous updates, the status of which should be monitored via /users:listStatuses.

Request Body

{"organizationNodeId"=>"EXMPLE", "loginId"=>"stevens@avaya.com", "lastName"=>"Stevens", "firstName"=>"Alex", "displayName"=>"Stevens, Alex", "emailId"=>"stevens@avaya.com", "profileId"=>"FSADSJ", "memberOfGroups"=>["04703a3a-3dfb-4606-ae79-fd0fe0be3e64"], "ownedGroups"=>["04703a3a-3dfb-4606-ae79-fd0fe0be3e64"], "roles"=>["Agent"], "addresses"=>[{"addressId"=>"04303a3a-3dfb-4606-ae79-fd0fe0be3e43", "addressName"=>"Address Name", "addressType"=>"APARTMENT", "addressTypeNumber"=>"101", "streetNumber"=>"A11", "streetName"=>"Allstate Pkwy", "city"=>"Markham", "state"=>"ON", "countryCode"=>"ZW", "zip"=>"L3R9T8", "isDefault"=>true}, {"addressName"=>"Address Name", "addressType"=>"OFFICE", "addressTypeNumber"=>"101", "streetNumber"=>"A11", "streetName"=>"Allstate Pkwy", "city"=>"Markham", "state"=>"ON", "countryCode"=>"ZW", "zip"=>"L3R9T8", "isDefault"=>false}], "accountAddresses"=>[{"addressId"=>"c8c2909d-75e9-484a-94c0-b7e8d29771fe", "isDefault"=>true}], "features"=>{"matching"=>{"attributes"=>["Language.English", "Language.French"], "queues"=>[{"queueId"=>"620bbb28-7112-433a-af59-17ee0f15a247", "proficiency"=>10}, {"queueId"=>"07d2c0a3-f05c-47e7-a86e-51148d3d4fd4", "proficiency"=>6}]}, "chat"=>{"autoAnswer"=>false, "multiplicity"=>2, "afterContactWork"=>false}, "messaging"=>{"autoAnswer"=>false, "multiplicity"=>2, "afterContactWork"=>false}, "email"=>{"autoAnswer"=>false, "multiplicity"=>2, "afterContactWork"=>false}, "voice"=>{"autoAnswer"=>false, "afterContactWork"=>false}, "cmvoice"=>{"agentLoginId"=>11021, "agentPassword"=>81238, "extensionNumber"=>1111, "communicationProfileAddresses"=>[{"address"=>"10022@SipDomain1.com", "type"=>"SIP", "isDefault"=>true}, {"address"=>"+12345@avaya.com", "type"=>"E164", "isDefault"=>false}], "communicationProfilePassword"=>"anypasswordstring"}}}

HEADERS

KeyDatatypeRequiredDescription
appkeystring
Content-Typestring
Acceptstring