inviteUserByEmail

abstract suspend fun inviteUserByEmail(email: String): RainbowResult<Invitation>

Sends an email invitation or a visibility request to register or connect on Rainbow.

This API behaves differently depending on whether the provided email address is already associated with a Rainbow account:

  • If the email corresponds to an existing Rainbow user who is not in the logged-in user's network, a visibility request will be sent to connect with the user.

  • If the email is not registered with any Rainbow account, an invitation will be sent to the provided email address, allowing the recipient to create a Rainbow account.

Return

A RainbowResult containing the Invitation on success. If the operation fails, the RainbowResult will contain error details.

Parameters

email

The email address of the contact to invite or send a visibility request to.