• Creates a new invite. Please validate the response invitation records to ensure the desired contact method was used and worked. Eg: It will tell you if the email was sent successfully.

    Parameters

    • params: {
          accountId: string;
          api?: GuardianApi.Api;
          email?: string;
          emailTemplateKey?: string;
          groupIds?: string[];
          login?: string;
          mobile?: string;
          req?: IReqParams;
          userId?: string;
      }
      • accountId: string
      • Optional api?: GuardianApi.Api
      • Optional email?: string
      • Optional emailTemplateKey?: string
      • Optional groupIds?: string[]
      • Optional login?: string
      • Optional mobile?: string
      • Optional req?: IReqParams
      • Optional userId?: string

    Returns Promise<{
        invite: IInvite;
        manualInvite?: IInvite;
        manualInviteCode?: string;
        user: IUser;
        warnings?: string[];
    }>

Generated using TypeDoc