Add Subscribers

Here is a step-by-step guide on how to add subscribers to a Venue as a Venue Administrator.

As a Venue Administrator, you may upload subscribers or add individual subscribers. For Network Administrators, click here.

What is a Subscriber?

A subscriber is an end-user of the internet service at a Venue. For a multi-family community, consider this a resident of the property. A subscriber differs from a guest who is at the venue on a short-term basis and needs temporary access.

How to Upload Subscribers Using the Provided Template

You may upload subscribers using a CSV file. Navigate to your Venue Administrator Console->Residents->Export Residents. This will download a file of your existing residents (if any). You can use this same template to upload new subscribers.

How to Use the Subscriber Upload Template

Each column represents a value that VAULT needs to add a subscriber. The columns marked with a "*" are required. It's critical that you do not change the headers in the first row of the template, or your subscriber upload may fail. That includes not removing the "*"

Here is what each of the values in the template mean;

  • Unit ID: The ID for the unit you will add the subscriber to.

  • Building: The building ID for the unit you will add the subscriber to.

  • Floor: The floor ID for the unit you will add the subscriber to.

  • Given Name: The subscriber's first name.

  • Family Name: The subscriber's last name.

  • E-mail: The subscriber's e-mail address.

  • Locale: The language preference for the subscriber.

    • "en-us" for English.

    • "es-xl" for Spanish.

  • Phone: The subscriber's phone number. The format must include a country code.

    • For the United States, the format is +1xxxyyyzzzz

  • Address 1, Address 2, City, State, Postal Code: The address information for the unit. This can be the same as the venue address or different.

  • Contact by Email: A true value means the subscriber has given permission to be contacted via e-mail for non-business critical communications. A false value means they have not given permission. Note: Subscribers cannot opt out of business critical communications.

  • Contact by Text: A true value means the subscriber has given permission to be contacted via text. A false value means they have not given permission.

  • Start Date: The start date for the subscription.

  • End Date: The end date for the subscription. If you do not enter an end date, the subscription will be active in perpetuity until it is ended.

  • Subscriber Token: If the subscriber already exists, this is their unique identifier.

  • External Subscriber ID: Use this value for a subscriber ID that is external to VAULT, such as your own company's customer ID.

  • External Subscription ID: Use this value for a subscription ID that is external to VAULT, such as your own company's subscription ID.

How to Upload The Subscriber Upload Template

Once you've completed your template, save the file as a CSV. VAULT will not recognize other formats. Navigate to your Venue Administrator Console->Residents->Bulk Upload Residents->select your file using your operating system's file explorer. The upload will begin immediately.

How to Add an Individual Subscriber

You may also add a subscriber individually. From your Venue Administrator Console, click the dashboard button, "Add New Resident." Enter the same values from the upload CSV and select "Add Resident."

Adding a Subscriber to a Retail Service Plan

If your selected service plan has a price, you will be prompted to enter the subscriber's credit card information. You may enter now, or you can close the prompt, and the subscriber will be asked to enter their information upon logging into the Subscriber Console. The subscriber will not be able to view their Wi-Fi password until they enter their credit card information.

Last updated