Skip to main content

πŸ“˜ CSV Upload (User): Fields, Format & Step-by-Step Guide

Updated over 3 weeks ago

πŸš€ Quick Overview

With the CSV upload, you can create or update many users at once.

  • Each row in the file represents one person.
    ​
    ​

  • Required fields must be filled in, otherwise the upload will be rejected.
    ​
    ​

  • After the import, you will immediately see how many users were created or updated.
    ​


πŸ› οΈ Before You Start

  • Permissions: Only users with the Client Admin role can upload CSV files.
    ​
    ​

  • File format: .csv
    ​
    ​

  • Delimiter: , (comma). If your file uses ;, adjust it before uploading.
    ​
    ​

  • Date format: YYYY-MM-DD (e.g., 2024-09-10)
    ​
    ​

  • Multi-values: Use the pipe | separator, e.g. Team1|Team2.
    ​
    ​

  • Max file size: 32 MB (~150,000 rows possible).
    ​
    ​

⚠️ Common pitfalls:

  • Required fields empty β†’ upload rejected.
    ​
    ​

  • Different number of columns between header and rows β†’ error.
    ​
    ​

  • Wrong date format or invalid values (e.g., phone numbers with letters) β†’ row invalid.
    ​


πŸ“‘ Step-by-Step Guide

1. Download CSV

  1. Go to the Employees menu in the admin area.
    ​
    ​

  2. Click Download CSV (top right).
    ​
    ​

    • The file will be downloaded as .csv (either an empty template or including current data).
      ​


2. Edit CSV

  • Open the file in Excel, Google Sheets, or another spreadsheet tool.
    ​
    ​

  • Fill in the data.
    ​
    ​

  • Always save the file again as CSV (UTF-8, comma-separated).
    ​


3. Upload CSV

  1. Go back to the Employees menu in the admin area.
    ​
    ​

  2. Click Upload CSV file.
    ​
    ​

  3. Select your prepared file.
    ​
    ​

  4. (Optional) Enable/Disable Users
    ​
    ​
    ​
    ⚠️ Important: Before using this option, please read the section
    β€œEnable/Disable Users”.
    Incorrect usage can unintentionally block many users.
    ​
    ​
    ​

  5. Click Next.
    ​
    ​

  6. Review the preview:
    ​
    ​

    • βœ… Green check = valid rows.
      ​
      ​

    • ❌ Red cross = errors (hover to see details).
      ​
      ​

  7. Fix issues in your file if needed and re-upload.
    ​
    ​

  8. Click Import.
    ​
    ​

  9. After completion, you will see how many users were created or updated.
    ​


⚠️ Important Note: Enable/Disable Users

If you activate this option, the system will behave as follows:

  • All users in your CSV will be set to active β†’ even those previously blocked will be reactivated.
    ​
    ​

  • All existing users not included in the CSV will be blocked.
    ​
    ​

βœ… When useful

  • If you upload a complete, up-to-date list of all users.
    ​
    ​

  • Example: You export all employees, adjust data (e.g., phone numbers), and upload the full list again.
    ​
    ​

❌ When risky

  • If you only want to add a few new users.
    ​
    ​

  • If you only want to make small updates (e.g., one user’s phone number).
    ​
    ​

  • If you are not sure your CSV contains all users.
    ​
    ​

Example:

You currently have 200 active users in the system.

You upload a CSV with 50 users and select Enable/Disable Users.

β†’ Result: The 50 users in the CSV remain active.

β†’ The other 150 are blocked and lose access immediately.

πŸ“Œ Recommendation:

  • Only enable this option if your CSV truly contains all active users.
    ​
    ​

  • For partial updates (e.g., adding 5 colleagues or changing one phone number) β†’ leave this option disabled.
    ​
    ​

πŸ”’ Exception: Users with the Client Admin role will never be blocked, even if they are not included in the file.


πŸ“‹ Field Reference (Users)

Column
​name

Description

Required

Data
​type

Allowed values / Format

Example(s)

Common errors

email

Email address (unique identifier)

Yes

Email

max. 254 chars, valid format

Invalid format, missing

password

Password
(only for new users)

No

Text

free

Secure123!

–

first_
name

First name

Yes

Text

max. 100 chars

Maria

Missing

last_
name

Last name

Yes

Text

max. 100 chars

Meier

Missing

academi
_title

Title

No

Text

max. 255 chars

Dr.

–

personal
_number

Internal ID

No

Text

max. 255 chars

EMP12345

–

birthdate

Date of birth

No

Date

YYYY-MM-DD

1980-12-20

Wrong format

gender

Gender

No

Enum

Male, Female, Other

Female

Invalid value

position

Job position

No

Text

max. 255 chars

Project Manager

–

category

Categories

No

Multi

`

`-separated, must exist in app

`HR

goal

Personal goal

No

Text

very long text possible

Career development

–

mobile_
country_
code

Country code (with +)

No

Text

+xx, valid code

+41

Invalid code

mobile_
phone

Mobile number

No

Number

digits only

791234567

Contains letters

busines
_phone

Business phone

No

Number

digits only

321654987

Contains letters

language

Language in the app

No

Enum

en, de, fr, it, es, pt-pt

de

Not supported

sms_
enabled

SMS notifications enabled?

No

Bool

Yes / No

No

Typo

start_
date

Start date

No

Date

YYYY-MM-DD

2023-11-21

Wrong format

termination_
date

Termination date

No

Date

YYYY-MM-DD

2025-04-24

Wrong format

roles

Roles in the system

No

Multi

`

`-separated

`HR admin

teams

Assigned teams (via external_id)

No

Multi

`

1|2|3| or just one
number

`team_1

πŸ’‘ Tip for partial updates:
If you only want to update certain information for employees (e.g. personal numbers or phone numbers), we recommend removing all columns you do not intend to change. If you leave other columns empty and upload the file, the existing values in those fields will be overwritten and deleted.
​

Example:
You only want to update the personal numbers and leave the Long-term development goal column empty. If you upload the file like this, the existing development goals in those profiles will be removed.
​

➑️ Recommendation: Keep only the columns in your CSV that you actually want to update.
​


❌ Typical Error Messages & Fixes

  • β€œEmail is required.” β†’ email column missing or empty.
    ​
    ​

  • β€œBirthdate is not in the right format.” β†’ Value must be YYYY-MM-DD.

  • β€œMobile phone can only contain numbers.” β†’ Remove letters or spaces.
    ​
    ​

  • β€œTeam with external id @id does not exist.” β†’ Team must exist in the system or in the same file.
    ​
    ​

  • β€œUnsupported delimiter.” β†’ Save the file with comma ,, not semicolon ;.
    ​


πŸ“ Examples

Minimal valid CSV (only required fields)

email,first_name,last_name

[email protected],Anna,Muster

Full CSV (all fields)

email,password,first_name,last_name,academic_title,personal_number,birthdate,gender,position,category,goal,mobile_country_code,mobile_phone,business_phone,language,sms_enabled,start_date,termination_date,roles,teams

[email protected],Secure123!,Anna,Muster,Dr.,EMP001,1985-05-12,Female,Project Manager,HR|Finance,Career development,+41,791234567,321654987,de,Yes,2020-01-15,2024-12-31,HR admin|Surveys/user,team_1|team_2


βœ… Pre-Upload Checklist

  • File is .csv in UTF-8 format
    ​
    ​

  • Delimiter is , (comma)
    ​
    ​

  • Required fields filled (email, first_name, last_name)
    ​
    ​

  • Dates in format YYYY-MM-DD
    ​
    ​

  • Multi-values separated with |
    ​
    ​

  • Phone numbers digits only, country code with +
    ​
    ​

  • Same number of columns in all rows
    ​
    ​

  • No typos in column headers
    ​
    ​

  • Languages and roles exist in the system
    ​
    ​

  • File smaller than 32 MB
    ​


❓ FAQ

What happens if a user already exists?

β†’ The record will be updated (email is the unique identifier).

Can I deactivate users?

β†’ Yes, using the β€œEnable/Disable Users” option. Users not in the file will be blocked.

Do I need to upload teams first?

β†’ Recommended: Yes. This way you can directly assign users to teams.

Can I assign multiple roles or teams?

β†’ Yes, separate with |, e.g. HR admin|Surveys/user.

Which languages are supported?

β†’ en, de, fr, it, es, pt-pt.

Why do I see red crosses in the preview?

β†’ One or more rows contain errors (wrong format, missing required fields).

How big can the file be?

β†’ Up to 32 MB (~150,000 rows).

Can I use special characters or umlauts?

β†’ Yes, as long as the file is saved in UTF-8 encoding.


πŸ†˜ Support

For support requests, please provide:

  • Upload timestamp
    ​
    ​

  • The CSV file (or a sample row with error)
    ​
    ​

  • The exact error message from the system
    ​
    ​

  • Your browser and version
    ​


πŸ‘‰ Note: The technical documentation also describes team-specific CSV columns. Your current template only contains user fields. If you want to manage teams via CSV, you will need a separate template with columns such as external_id, name, type.

Did this answer your question?