sendInvitationEmail

Overview

This mutation sends an invitation to create an borderless account to the given email account.

Special Considerations

  • Requires an email address as an input.

Inputs

MutationSendInvitationEmailArgs

Required Data

toEmail: string

Returns

Promise<SuccessResult>

A promise containing a success message.

Example

Running this mutation:

mutation {
  sendInvitationEmail(toEmail: "test@getborderless.com") {
    message
  }
}

Gives us:

{
  "data": {
    "sendInvitationEmail": {
      "message": "Invitation email sent to test@getborderless.com"
    }
  }
}

Common Errors

When running this mutation some of the common errors encountered include:

  • An account already exists with this email address. (I-4901)

    • The given email is already associated with a borderless account.

  • Could not send invitation email to ...: ... (E-7101)

    • There was an error sending the email to the given address.
← requestPasswordResetsendInvitedRegisterEmail →