- 21 Mar 2024
- 2 Minutes to read
- Print
- DarkLight
- PDF
Import or Update Users
- Updated on 21 Mar 2024
- 2 Minutes to read
- Print
- DarkLight
- PDF
You can add or update one or more user accounts from a CSV (spreadsheet). When new user accounts are created the users will not receive a welcome email to set their credentials. You must provide this information to your users.
IMPORTANT: Always specify the user_id if you wish to update user accounts, otherwise a user creation will be attempted. For the email change use case, if user id is not specified it will create a new user account for the provided email value.
Tip: Use the Export users feature and then update the needed values of current user accounts. If needed, add new users, with user_id empty, at the bottom of the file.
Click Import users.
Click Download CSV template. Fill out all required fields in the format shown.
Allowed fields:
Field name
Description
user_id
When creating a user this field has to be empty. If user id is specified, then the import does an update on the user with that user_id, with the values set in the csv file. An invalid or not existing id will result in a failed import.
email
When creating a user, an email address must be typed in. Important: if user_id is empty, you will create a user for this email. Do not leave the user_id empty if you want to actually change the email for this user, fill in their user_id by using export users feature. When updating a user, you can specify a new email address [local part/domain part], the same address or leave the column empty.
first_name
When creating a user, you can specify the user's first name or leave the field empty. When empty, the default value firstname will be set. When updating a user, you can specify a new first name or it can be an empty field. (User_id needs to be filled in for the update of the user).
last_name
When creating a user, you can specify the user's last name or leave the field empty. When empty, the default value lastname will be set.When updating a user, you can specify a new last name or it can be an empty field. (User_id needs to be filled in for the update of the user).
country
When creating a user, you must specify a country code. When updating the user, you can specify a new country code or leave the field empty (User_id needs to be filled in for the update of the user).
language
When creating a user, you must specify a language code. When updating the user, you can specify a new language code or leave the field empty (User_id needs to be filled in for the update of the user).
password
When creating a user, you can define a first time password that has to be compliant with the required rules. On the first sign in the user will need to set a new password. For updating a user account, password input is ignored.
If you update users, all empty fields will not change the existing values of the user.
E.g for updating in Notepad, Notepad++ a user’s last name: 0a00a00a-a000-000a-aa00-a000a0000000,,,Doe,,,
The CSV file size should not exceed 10 MB.
Click Choose File.
Upload the .csv file.
Click Import or update user.
Note: After you click Import or update user the status of your import will be displayed in the top right corner popup. You can close the popup by clicking anywhere in the page or by clicking the hourglass icon, in the top right navigation bar.You can Download your report within the Jobs popup as CSV or JSON.