@wildix/xbees-conversations-client > UserToInvite
UserToInvite interface
Signature:
export interface UserToInvite
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
boolean | undefined | (Optional) 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. | ||
string | undefined | (Optional) The email address of the invited user. If no user exists with the specified email and "colleague" flag is provided, the system will retrieve the colleague's details from the PBX. | ||
string | undefined | (Optional) An optional name for the invited user. If the user logs in later and a different name is provided via SSO or the PBX, the system will update the user's name accordingly. | ||
string | undefined | (Optional) The phone number of the invited user. This phone number is used to create or find the user if an email address is not provided. |