Skip to main content
User Import Guide

This guide outlines how to quickly add or update multiple users at once by uploading a properly formatted CSV file. Follow the steps below to avoid common errors and ensure a smooth user import process.

Updated over a week ago

Overview

Bulk importing users allows you to quickly add or update multiple users at once. Below are the key points and steps to ensure a successful import.


Important Limits and Requirements

  • Maximum Rows: Each CSV can contain up to 2,000 rows (users) per import.

  • CSV File Format: Ensure your file is properly formatted. Incorrectly formatted fields can cause the import to fail.

  • Email Format: Each primary email must follow the standard format, e.g., [email protected].


Common Reasons for CSV Upload Failure

  • Invalid Email Format: The primary email for every user entry must be in the form [email protected].

  • Unknown Sources (Usernames): If you include a source in a user's "Source Username(s)" column that isn't enabled in your account, the import will fail.


How to Bulk Import Users

  1. Navigate to User Management: Go to the User Management page found in Settings.

  2. Locate the "Import Users" Button: This is in the top-right area of the page.

  3. Follow the Import Instructions: When prompted, you will:

    1. Download the Import Template.

    2. Fill out the Import Template with your user information.

    3. Save the file as a CSV.

    4. Select the saved file to upload.

  4. System Processing: The system will process your file and:

    • Provide an error report if there are issues.

    • Allow you to continue if everything looks good.

  5. Review Import Results: The next screen will show how many new users will be added and how many existing users will be updated.


How to Fill Out the User Import Template

When you open the downloaded User Import Template, you will see the following column headers:

Current Status  Display Name  Primary Email  Role  Groups  Source Username(s)

Below is an explanation of each column:

A: Current Status

  • This is the current status of the user being imported.

  • Expected Entries: Active or Archived

    • Active: The user will be active immediately upon a successful import.

    • Archived: The user will be imported as archived.

      • Useful for importing historical users who need to remain in the system for record-keeping but do not need active monitoring.

B: Display Name

  • The display name of the user.

  • Expected Entries: Any name format (e.g., John Doe, Doe, John, John R. Doe). This display name appears in system communications, alerts, and collections.

C: Primary Email

  • The user's primary email, often their work email address.

  • Expected Entries: A valid email address (e.g., [email protected]). Must include @domain.com/org/tech/edu/gov etc.

D: Role

  • Determines the role for the user being imported or updated.

  • Expected Entries: User, Admin, or Supervisor

  • Refer to our user roles documentation for more details on user roles.

E: Group(s)

  • Assign users to a specific group or multiple groups. Use only a comma to separate multiple groups (e.g., Group 1,Group 2).

  • Adding to Existing Groups: The groups listed here will be added to the user's existing group memberships.

  • No Groups: If you do not want the user in any group, enter none.

  • Expected Entries:

    • Single group: Group 1

    • Multiple groups: Group 1,Group 2

    • No groups: none

    • Note: Groups must exist in the system prior to the import.

F: Source Username(s)

  • These are unique identifiers for users on different communication platforms (sources).

  • Additional Identifiers: If a user already has a unique identifier in the system, and you include a new identifier in the CSV, the new identifier will be added to their existing identifiers.

  • Existing Sources: Confirm which sources are enabled in your account by checking the "Message Volume by Source (Last 30 days)" widget on the overview page.

  • Expected Entries: The format depends on the source, for example:


Next Steps

After preparing the CSV, follow the import process. If any errors occur, review the log, correct the CSV, and attempt the upload again. Once the import is successful, your new users will be active or archived, and updated users will reflect any changes you made.

Did this answer your question?