@wildix/xbees-conversations-client > UserToInvite > colleague

UserToInvite.colleague property​

A flag to indicate that specified email are registered colleague on the PBX. When provided, the system will search for the colleague on the PBX and automatically establish a connection to the organization if one does not already exist. If the specified colleague does not exist on the WMS, a ValidationException will be thrown and no users will be invited.

Signature:

colleague?: boolean | undefined;