InviteModel

Model from the User invite process

Methods

The following API methods use this data model.

• Invite User

  Read-Only Fields

  These fields are assigned by the API server and cannot be changed.

  email

string, nullable, read-only

The invited email address

success

boolean, read-only

True if the invite was sent successfully

errorMessage

string, nullable, read-only

The error message if the invite was not successful

Optional Fields

invitedUser

UserAccountModel, nullable

The invited user, may be null if the user could not be invited