Update Profile

patch

https://core.{customerId}.ec.avayacloud.com/api/config/v1/profiles/{profileId}

This API requires Account Administrator role.

Updates an existing profile with new configuration data. Only provided fields will be updated.

When profile settings are changed, a background sync job (PRFUPD) is automatically queued to propagate
the updated settings to all users assigned to this profile. The sync preserves any user-specific overrides;
only non-overridden fields are updated to match the new profile values.

Validation Rules:

Profile name must be unique within the account (if being changed)
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

User limit:

A profile may have at most 500 assigned users (see Users API for assignment rules).
Profile updates are rejected when numUsers exceeds 500 (updates remain allowed at exactly 500).
Returns 422 with detail Profile User limit of 500 reached. Cannot update profile
(violations[].code: 20005).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

profileId

string

required

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 unique identifier of a profile.

Body Params

Request body for updating an existing profile. All fields are optional - only provided fields will be updated.

name

string

length between 1 and 100

Name of the profile (must be unique within the account if being changed)

description

string | null

Optional description of the profile

licType

string

enum

License type (will apply new defaults if changed)

Allowed:

profileFolderId

FolderId | null

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

locationId

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

queues

object

Queues configuration for a user or profile.

spaces

object

Space configuration for the profile

tags

attributes

object

Profile attributes configuration

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

DefaultOutboundCallerId | null

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

appTheme

string

enum

Application theme preference

Allowed:

consoleTheme

string

enum

Console theme preference

Allowed:

interactionViewsType

string

enum

Defaults to all

Type of interaction views to display

Allowed:

definedInteractionViews

array of strings

List of defined interaction views

definedInteractionViews

modifyInteractionViews

boolean

Whether user can modify interaction views

timeZone

string

length ≤ 64

User's timezone preference (IANA timezone)

commTypeChangeDefaultValue

CommTypeChangeDefaultValue | null

externalUCProviderConnections

array of objects

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

externalUCProviderConnections

crmConfigId

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

logConfiguration

object

Log configuration settings for users in this profile

enableWebHID

boolean

Whether WebHID is enabled for the user

enableErrorTones

EnableErrorTones | null

Optional. Send null to clear (revert to default).

allowInternalCalls

AllowInternalCalls | null

Optional. Send null to clear (revert to default).

rejectInteractions

RejectInteractions | null

Optional. Send null to clear.

allowAgentEditAutoAnswer

AllowAgentEditAutoAnswer | null

Optional. Send null to clear (revert to default).

allowAgentEditWebHIDHeadsetControl

AllowAgentEditWebHIDHeadsetControl | null

Optional. Send null to clear (revert to default).

deferEnabled

Whether defer is enabled for this profile. Null means not set at profile level (inherit account or queue behavior).

previewOutbound

PreviewOutbound | null

Optional. Send null to clear.

predictiveOutbound

PredictiveOutbound | null

Optional. Send null to clear.

persistentMedia

PersistentMedia | null

Optional. Send null to clear.

dialPlanProfileId

DialPlanProfileId | null

Optional. Dial plan profile ID. Send null to clear.

ucPhoneSpaces

UcPhoneSpaces | null

Optional. Number of UC phone interaction spaces (0-3). Send null to clear.

useUCPhoneSpaceOnCCCall

UseUCPhoneSpaceOnCCCall | null

Optional. Send null to clear (revert to default).

useCCPhoneSpaceOnUCCall

UseCCPhoneSpaceOnUCCall | null

Optional. Send null to clear (revert to default).

infinityElements

array of strings

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

infinityElements

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200Profile updated successfully

400Bad Request

401Unauthorized

403Forbidden

404Not Found

409Conflict. Two cases: Duplicate name: a profile with the same name already exists in this account. Active sync job: a PRFUPD or FSYNC job is currently running for this profile.

422Unprocessable Entity. Cases include: Constraint violation: request body fails field validation Profile user limit: profile has more than 500 assigned users and cannot be updated

500Internal Server Error

defaultInternal Server Error