inviteUser

abstract suspend fun inviteUser(inviteUser: InviteUser): RainbowResult<Invitation>

Sends an invitation using the InviteUser.Builder.

This API allows sending an invitation to a user, either by email, phone number, or directly by ID. The invitation content is defined by the InviteUser object, which includes the details for the invite.

Return

A RainbowResult containing the Invitation on success. In case of failure, the RainbowResult will include error details.

Parameters

inviteUser

The content of the invitation, encapsulated in the InviteUser object.