Professional

Object

samlUserId

Id used to bind a user from a SAML identity provider to an iAdvize user.

This field is now deprecated. This means that iAdvize now considers that this field should not be used and you should migrate any usage of that field. iAdvize will only maintain this field up until the 2025-04-07.

samlId

Id used to bind a user from a SAML identity provider to an iAdvize user.

interfaceLanguage

Language in which to display the platform interface.

This field is now deprecated. This means that iAdvize now considers that this field should not be used and you should migrate any usage of that field. iAdvize will only maintain this field up until the 2025-04-07.

externalId

The external id is an identifier representing the user in another system.

group

Group this user is a member of. For more information, see https://help.iadvize.com/hc/en-gb/articles/203280696-Use-the-user-groups .

askForClickToCallPhoneNumber

Specifies if the operator should be prompted for a click to call phone number.

This field is now deprecated. This means that iAdvize now considers that this field should not be used and you should migrate any usage of that field. iAdvize will only maintain this field up until the 2025-04-07.

clickToCallPhoneNumber

The phone number used to call the operator or a voip identifier.

This field is now deprecated. This means that iAdvize now considers that this field should not be used and you should migrate any usage of that field. iAdvize will only maintain this field up until the 2025-04-07.

roleName

Role name, e.g. "admin", "manager", "operator".

This field is now deprecated. This means that iAdvize now considers that this field should not be used and you should migrate any usage of that field. iAdvize will only maintain this field up until the 2025-04-07.

role

The User's role, including custom roles.

channels

Configuration of the different channels for this user.

lastLoggedAt

Last time the user logged in.

id

User id.

email

User email.

lastName

User last name.

firstName

User first name.

pseudo

The user pseudo will be displayed under the avatar in the chatbox. It can be used to keep the real identity of agents secret and to attribute a nickname to the user profile.

This field is now deprecated. This means that iAdvize now considers that this field should not be used and you should migrate any usage of that field. iAdvize will only maintain this field up until the 2025-04-07.

userName

The user-name will be displayed under the avatar in the chatbox. It can be used to keep the real identity of agents secret and to attribute a nickname to the user profile.

avatarUrl

User avatar url.

This field is now deprecated. This means that iAdvize now considers that this field should not be used and you should migrate any usage of that field. iAdvize will only maintain this field up until the 2025-04-07.

avatar

User avatar url.

createdAt

User creation datetime.

isDeleted

Indicates if User has been deleted.

deletedAt

User deletion datetime.

spokenLanguages

Languages in which the user is able to accept a chat.

This field is now deprecated. This means that iAdvize now considers that this field should not be used and you should migrate any usage of that field. iAdvize will only maintain this field up until the 2025-04-07.

skills

Skills of the user. The user's skills can be used to determine which routing group the user will be a member of. For more information regarding how to create and use skills, please see the following documentation: https://help.iadvize.com/hc/en-gb/articles/203444283-Use-the-skills .

presence

Presence of the user.

availability

Channels availabilities of the user.

projects

Projects assigned to the user, determining which projects the user can handle conversations for.

countryPreferences

User's preferences concerning locale, time/date format, etc.