The User Importer allows you to create and update user accounts in bulk using a structured spreadsheet file. To access it, navigate to Users > User Importer. If this option is not visible to you, please contact Evotix to have it enabled on your account.
Once on the User Importer page, you can download the import schema - a template file that lists all available fields you can populate for import or update.
Field Mapping
The table below shows all available import fields and the system fields they correspond to
Import Field Name | System Field Name | Description |
user_login | Username | User's username |
user_pass | Password | User's password (must meet password strength criteria) |
user_nicename | Nickname | Can be selected to appear on user's profile view |
user_email | Email address | User's email |
user_url | Website | URL |
first_name | First Name | User's first name (Text field) |
last_name | Last Name | User's last name (Text field) |
role | Role | The permissions the user will be assigned |
groups | Group Membership | The Access Group the user will be assigned to |
location | Location | User's location (text field) |
jobtitle | Job Title | User's job title (text field) |
company | Company | User's company (text field) |
Mandatory fields
When creating new users, the user_login (Username) field is mandatory.
When updating existing users, your file must include either user_login or user_email so the system can identify the correct record.
Key Considerations
Marking fields for update: When updating existing user details, add an asterisk (*) as a prefix to the relevant column header - for example, *first_name.
Empty fields: Empty fields will be ignored during import. If you want to clear the data from a specific field, prefix the relevant column header with an exclamation mark (!) - for example, !jobtitle.
Email uniqueness: Each email address must appear only once in your import file. If the same email appears on multiple rows, the system will create the user based on the first row and treat any subsequent rows with that email as updates to the same account.
Password requirements: Password strength rules configured in your system are enforced during import. If a password in your file does not meet those requirements, the import will return an error for that record.
Nicknames: If you do not provide a value in the nickname field, the user's username will be used as their nickname by default.
Data Types and Slugs
Most fields accept plain text input. However, the Role and Group Membership fields require a specific slug value rather than the display name.
The slugs for each available role are as follows:
| Role Name | Slug |
Reporting | reporting |
Systems Administrator | administrator |
Developer | designer |
Content Administrator | editor |
Author | author |
Contributor | contributor |
Subscriber | subscriber |
For Group Membership, the slug will depend on what your access groups have been named. To find a group's slug, navigate to Access Groups and refer to the slug column in the table.
If you need to assign a user to multiple access groups, simply enter each slug separated by a comma - for example: internal-content,default.
If you enter an access group slug that does not yet exist in the system, the import will automatically create that access group and assign the user to it. The description of any access group created this way will note that it was generated via the import tool.
Running the Import
Once your file is prepared, upload it by selecting Choose File and locating your completed import file. When you are ready, select Upload to begin the import process.