API Reference

Update a user

patch
https://core.{customerId}.ec.avayacloud.com/api/config/v1/users/

Required Role: Admin Portal or Admin API Consumer

Update one or more properties of a user. The user can be identified by their user ID
or email address.

Agent Self-Edit Restrictions
When an agent edits their own profile (self-edit), the server enforces the following:

Read-only identity fields:
The following fields are always read-only for agents and cannot be modified via self-edit.
Any attempt returns 403 Forbidden:
firstName, lastName, namePrefix, nameSuffix, title, email, mobile.
These fields can only be changed by an administrator.

Auto Answer / WebHID Edit Restrictions:

  • If allowAgentEditAutoAnswer is false on the user record and the request includes
    a change to attributes.webRTC.autoAnswer.interaction, the server returns 403 Forbidden.
  • If allowAgentEditWebHIDHeadsetControl is false on the user record and the request
    includes a change to attributes.webHID.status, the server returns 403 Forbidden.
  • Administrators editing other users are never restricted by these flags.
  • Agents can still modify unrestricted fields (language, timezone, app theme, queues, etc.)
    even when identity and Auto Answer / WebHID edits are restricted.

Agent Self-Edit Restrictions
When an agent edits their own profile (self-edit), the server enforces the following:

Read-only identity fields:
The following fields are always read-only for agents and cannot be modified via self-edit.
Any attempt returns 403 Forbidden:
firstName, lastName, namePrefix, nameSuffix, title, email, mobile.
These fields can only be changed by an administrator.

Auto Answer / WebHID Edit Restrictions:

  • If allowAgentEditAutoAnswer is false on the user record and the request includes
    a change to attributes.webRTC.autoAnswer.interaction, the server returns 403 Forbidden.
  • If allowAgentEditWebHIDHeadsetControl is false on the user record and the request
    includes a change to attributes.webHID.status, the server returns 403 Forbidden.
  • Administrators editing other users are never restricted by these flags.
  • Agents can still modify unrestricted fields (language, timezone, app theme, queues, etc.)
    even when identity and Auto Answer / WebHID edits are restricted.

Disabling a User
A user can be disabled by performing an update to set the status property to disabled.
This can normally only be done if:

  • the user is not logged in
  • the user has no active interactions
  • the user has no pending interactions in their personal queue
    and a request to do so in any of those conditions will fail with a 422 error. This can be
    overridden by setting the forceDisable query parameter.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
required
^002[0-9a-f]{23}$

Either the user ID (26-character internal ID starting with '002'), email address,
or the special value "me" to retrieve the current authenticated user.

Unique identifier for a user.

Query Params
boolean
Defaults to false

Force a user to be disabled even while still active.

In an update uesr request, this parameter has no effect if the request payload does not
include setting the status to disabled.

Body Params

Request body for updating an existing user.

All fields are optional, however at least one must be included.

Merge Behavior:
Fields use different update strategies. Most scalar fields are replaced with the
provided value. Complex fields have specific behaviors noted in their descriptions.

string
enum

Is the user enabled or disabled?

Allowed:
string

A user's email address

string
length between 2 and 255
^[^<>\^@#]*$

The first name of a user.

string
length between 2 and 255
^[^<>\^@#]*$

The last name of a user.

string
length between 2 and 100
^[\p{L}0-9 '\-]*$

The public alias of a user. Supports letters (including international characters), digits, spaces, hyphens, and apostrophes.

string

The name prefix of a user.

string
enum

The name suffix of a user.

string
length between 1 and 510

The user's job title.

string
length ≤ 255
^(?=.{8,}$)(?=.*?[a-z])(?=.*?[A-Z])(?=.*?[0-9])(?=.*?\W).*$

Initial password for the user

string
enum

User license type that determines available features and permissions

Allowed:
uuid

Updates the profile associated with the user. Note: changing the profile ID
updates the association only — it does not re-apply profile defaults to the user.

FolderId | null

Move user to a folder, or send null to remove from current folder.

string
enum

Which provider is used to authenticate the user.

Allowed:
string
MobilePhoneNumber | null

Send null or empty string to clear.

string
^[\d+\s().-]*$
Extension | null

Send null to clear.

string
length ≥ 10
string
length ≥ 10
string
length between 10 and 20

Emergency outbound caller ID number.

LocationId | null

Send null to clear. When setting a location, email, firstName, and lastName
must also be provided.

string
string
length between 36 and 36
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
string
enum

Application theme preference

Allowed:
string
enum

Console theme preference

Allowed:
string
length ≤ 64

User's timezone preference (IANA timezone)

string
enum
Defaults to all

Type of interaction views to display

Allowed:
boolean

Can modify interaction views

CommTypeChangeDefaultValue | null

Send null to clear.

attributes
object

Merged with the user's existing attributes. Specific nested keys
(queue, time, webRTC, recording, signatures, sessionStats)
are deep-merged; all other keys are replaced.
Omit to leave unchanged.

permissions
object

Merged with the user's existing permissions per section (app, console).
Keys within each section are replaced with the provided values;
keys not included are preserved. Omit to leave unchanged.

spaces
object

Space configuration for a user or profile.

tags
array of strings

Replaces the user's entire tag list with the provided values.
Send an empty array to remove all tags. Omit to leave unchanged.

tags
groups
array of objects

Replaces the user's entire group membership with the provided group IDs.
Send an empty array to remove all group memberships. Omit to leave unchanged.

groups
string
^007[0-9a-f]{23}$

Unique identifier for a group.

queues
object

Only the sub-properties included in the request are updated; omitted
sub-properties are left unchanged. For example, sending only access
replaces the access list but leaves autoLogin and proficiency as-is.
The user's personal queue is always preserved in access and autoLogin.

definedInteractionViews
array of strings

Replaces the user's entire set of defined interaction views.
Omit to leave unchanged.

definedInteractionViews
boolean
EliteSbcGroupId | null

Send null to clear.

EliteAgentId | null

Send null to clear.

string

The password for the hybrid agent on Aura.

string

The password for the communication profile on Aura.

string
length between 32 and 32
^[0-9a-f]{32}$

Hash of communication profile password.

EliteSipAddress | null

Send null to clear.

EliteExtension | null

Send null to clear.

string
string

Elite Voice voicemail password.

string
enum
Allowed:
EliteCmConfigurationId | null

Send null or empty string to clear.

string
length between 36 and 36
^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

SIP trunk ID to associate with the user.

boolean
boolean
boolean
boolean
boolean
boolean

Manually set the AIDable flag. Note: this value may be overridden by
license enforcement rules when the license type changes.

boolean

Whether the user should send logs to the platform.

ReportsTo | null

Send null or empty string to clear.

DialPlanProfileId | null

Send null to clear.

boolean

Whether WebHID is enabled for the user

boolean

Whether error tones are enabled.

integer
≥ 0
integer
≥ 0
integer
≥ 0
integer
≥ 0
integer
≥ 0
UcPhoneSpaces | null

Send null to clear (revert to default).

UseUCPhoneSpaceOnCCCall | null

Send null to clear (revert to default).

UseCCPhoneSpaceOnUCCall | null

Send null to clear (revert to default).

AllowInternalCalls | null

Send null to clear (revert to default).

AllowAgentEditAutoAnswer | null

Send null to clear (revert to default).

AllowAgentEditWebHIDHeadsetControl | null

Send null to clear (revert to default).

voicemail
object

Voicemail settings.

infinityElements
array of strings

Replaces the user's entire set of Infinity Elements.
Omit to leave unchanged.

infinityElements
externalUCProviderConnections
array of strings

Replaces the user's entire set of external UC provider connections.
Omit to leave unchanged. IDs must belong to the same account.

externalUCProviderConnections
string
length ≤ 64

Calendar event provider identifier.

calendarEventStatusMap
object

Mapping of calendar event statuses.

LogConfiguration | null

Send null to clear.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 3 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/problem+json

Updated 3 months ago

Did this page help you?