API Reference

Create a user

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

Required Role: Admin Portal or Admin API Consumer

Creates a user.

The type of user is controlled by the license type, which is typically
an agent of some kind, but other types can be supported via the 'nonAgent' type.

At a minimum, creating a user requires:

  • the user's email address
  • the user's first and last names
  • the user's license type or a profile to apply to the user (the license type will be
    taken from the profile if specified)

License Types and Their Defaults:

  • nonAgent: Limited permissions, minimal spaces (1 task, 1 email, 1 messaging)
  • voiceOnlyAgent: Voice-focused permissions, phone space (2 task, 1 phone)
  • digitalOnlyAgent: Digital channels, no phone (3 task, 2 email, 2 messaging)
  • omniChannelAgent: All channels except video (3 task, 2 email, 1 phone, 2 messaging)
  • omniChannelAgentEnhanced: All channels with enhanced features and session statistics
  • hybridVoiceAgent: Balanced voice and digital capabilities

Validation Rules:

  • User's email address must be unique within the account
  • License type must be valid for the account
  • Profile must exist (if profile ID is provided)
  • Folder must exist (if folder ID is provided)
  • Location must exist (if location ID is provided) - location IDs are system-generated
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request body for creating a new user

string
required

A user's email address

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

The first name of a user.

string
required
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

The unique identifier of a profile.

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

Unique identifier for a folder.

string
enum

Which provider is used to authenticate the user.

Allowed:
string
string
length between 5 and 15
^(\+[1-9]\d{3,13}|\d{5,15})$

Mobile phone number - accepts E.164 format (+[country code][number]) or plain digits. Length 5-15 characters/digits.

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

The extension of an agent user.

string
length ≥ 10
string
length ≥ 10
string
length between 26 and 26
^022[0-9a-f]{23}$

Optional location ID to associate with the user or profile. Must be an existing location ID.

Note: Location IDs are system-generated 26-character identifiers with prefix "022".

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

string
enum

Default value for communication type changes

Allowed:
attributes
object

Attributes of the user or profile.

permissions
object

The permissions for a user or profile.

spaces
object

Space configuration for a user or profile.

tags
array of strings

List of tag names associated with the user or profile.

tags
groups
array of objects

Array of group identifiers that the user or profile belongs to. Each string is a groupId from the groups table (Edify-style IDs with 007 prefix).

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

Unique identifier for a group.

queues
object

Queues configuration for a user or profile.

definedInteractionViews
array of strings

List of defined interaction views

definedInteractionViews
boolean
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}$

The ID of the default SBC Group to use for calls involving this hybrid agent.

string
length ≥ 1

The hybrid agent's ID on Aura.

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.

string

The SIP address for the hybrid agent.

string
length ≥ 1

The hybrid agent's extension on Aura.

string
string
enum
Allowed:
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}$

The ID of the Elite CM Configuration associated with this user

boolean
boolean
boolean
boolean
boolean
boolean
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}$

ID of the dial plan profile to use

boolean

Whether WebHID is enabled for the user

boolean

Whether error tones are enabled.

integer
≥ 0
integer
0 to 3

Multiplicity Personal Queue Phone; number of UC/personal-queue phone spaces (0-3).

boolean

When true, use UC (personal queue) phone space for contact center/general queue calls.

boolean

When true, use contact center (general queue) phone space for UC/personal queue calls.

boolean

Whether the user or profile can make internal calls

boolean
Defaults to false

Controls whether the agent is allowed to edit their own Auto Answer Interactions setting (attributes.webRTC.autoAnswer.interaction) via the Edit Profile API. Defaults to false (agent cannot edit). When false and an agent attempts a self-edit that includes an Auto Answer change, the server returns HTTP 403 Forbidden. Administrators can always modify Auto Answer for any user regardless of this flag.

boolean
Defaults to false

Controls whether the agent is allowed to edit their own WebHID Headset Control setting (attributes.webHID.status) via the Edit Profile API. Defaults to false (agent cannot edit). When false and an agent attempts a self-edit that includes a WebHID status change, the server returns HTTP 403 Forbidden. Administrators can always modify WebHID settings for any user regardless of this flag.

externalUCProviderConnections
array of strings

External UC provider connection IDs to associate with the user.

externalUCProviderConnections
string

Elite Voice voicemail password.

logConfiguration
object

Log configuration settings for controlling logging behavior.
Used to configure client-side logging for users and profiles.

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/json
application/problem+json

Updated 3 months ago

Did this page help you?