Create Profile

This API requires Account Administrator role.

Creates a new profile with license-type-specific default configurations. The system automatically applies
appropriate defaults for permissions, attributes, spaces, and queues based on the specified license type:

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

Default Values Applied (if not provided):

  • appTheme: 'light'
  • consoleTheme: 'light'
  • timeZone: the account's configured default timezone
  • interactionViewsType: 'all'
  • modifyInteractionViews: true
  • allowInternalCalls: false
  • License-specific permissions, attributes, spaces, and queue configurations

Other optional fields (e.g. deferEnabled, previewOutbound, predictiveOutbound, persistentMedia,
rejectInteractions, ucPhoneSpaces) are left unset unless provided; see each field's description
for its specific fallback behavior.

Validation Rules:

  • Profile name must be unique within the account
  • License type must be valid for the account
  • Profile 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 profile with license-type-based defaults

string
required
length between 1 and 100

Name of a profile (must be unique within the account)

string | null

Optional description of the profile

string
enum
required

User license type that determines available features and permissions

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

Unique identifier for a folder.

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".

permissions
object

Profile permissions configuration (license-specific defaults applied if not provided)

queues
object

Queues configuration for a user or profile.

spaces
object

Space configuration for the profile (license-specific defaults applied if not provided)

tags
array of strings

List of tag names associated with the user or profile.

tags
attributes
object

Profile attributes configuration (license-specific defaults applied if not provided)

groups
array of objects

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

groups
DefaultOutboundCallerId | null

Default outbound caller ID (nullable for create/update requests)

string
enum

Application theme preference

Allowed:
string
enum

Console theme preference

Allowed:
string
enum
Defaults to all

Type of interaction views to display

Allowed:
definedInteractionViews
array of strings

List of defined interaction views

definedInteractionViews
boolean
Defaults to true

Whether user can modify interaction views

string
length ≤ 64

User's timezone preference (IANA timezone)

CommTypeChangeDefaultValue | null
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}$

Optional. CRM configuration ID to assign to users in this profile.

logConfiguration
object

Log configuration settings for users created from this profile

boolean

Whether WebHID is enabled for the user

boolean

Whether error tones are enabled.

boolean

Optional. Whether users in this profile can make internal calls. Defaults to false when not provided.

boolean
boolean
Defaults to false

Optional. Whether agents in this profile can edit their own Auto Answer setting.

boolean
Defaults to false

Optional. Whether agents in this profile can edit their own WebHID Headset Control setting.

boolean

Optional. Whether preview outbound dialing is enabled for users in this profile.

boolean

Optional. Whether predictive outbound dialing is enabled for users in this profile.

boolean

Optional. Whether persistent media is enabled for users in this profile.

boolean

Optional. Whether defer is enabled for users in this profile.

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

Optional. Dial plan profile ID to assign to users in this profile.

integer
≥ 0

Optional. Number of UC phone interaction spaces (0-3).

boolean

Optional. Whether to use UC phone space for contact center calls.

boolean

Optional. Whether to use contact center phone space for UC calls.

externalUCProviderConnections
array of objects

Array of external UC provider connection IDs to assign to this profile.

externalUCProviderConnections
infinityElements
array of strings

Optional. Array of Infinity Element IDs to assign to this profile.
Only valid for agent license types; requests that set this field for nonAgent
profiles are rejected with a 422 error.

infinityElements
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

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