Skip to main content

Import users using CSV file

Use a CSV file import to bulk import new users or update existing user data. You can choose the fields to import from the ones available in the CSV file. It includes an error report post-import to help you identify errors in the CSV file easily.

The following are the three different steps involved in importing a CSV file.

  1. Creating a CSV file with user details
  2. Importing the created CSV file
  3. Analysing import
note

During the CSV import process, the system allows simultaneous import of only two files at a time.

Step 1: Create CSV file with user details​

Create a CSV file with user details and ensure that the values passed in the CSV file adhere to the data types of user properties.

note

A CSV file cannot exceed 30 MB.

  1. Use appropriate header names: It becomes easy to map headers when their names are similar to user properties. It also leverages Auto column Mapping feature that simplifies the process of mapping headers by matching them with user properties that have similar names.
  2. Use the right data type: Data type validated before importing each user record. If the validation fails, adding or updating the record will fail.

The following table shows the data types of each user property with accepted values.

Data TypeAccepted Value
StringAny string value.
ListSemicolon ; separated values without spaces.
emailA valid email address format.
NumberAny integer or decimal number with max of 15 digits.
PhoneA valid phone number with country code.
urlA valid URL format.
dateISO date format - YYYY-MM-DD.
dateTimeISO standard date-time format - YYYY-MM-DD hh:mm:ss.
timeStandard time format - hh:mm:ss
booleanValue could be true or false, this is case insensitive.
tagsSemicolon ; separated values without spaces. Example: tag1;tag2

  1. Prefix country codes to mobile numbers - CountryCode+PhoneNumber. For example, an Indian phone number could be 919011111111 where 91 is the country code and rest is a phone number.

  2. Include all the properties you want to import such as firstname, lastname, gender, country, city, timezone, email optin, sms optin, or any custom property that is added for the project.

  3. Add tags that you want to associate with each user. To add multiple tags to a user, use a semicolon (;) between each tag without space. For example, regular_customers;campaign_responders.

  4. Save the file in the right CSV format: When creating the CSV file from tools like Microsoft Excel, ensure you save it in the format CSV (Comma delimited).

note
  • It is required to pass phone numbers with country codes in a CSV file.
  • You can associate any column header to userId. Ensure the column contains unique identifiers such as phone number or email address. There is no need to mention it separately in the CSV file.

Step 2: Import CSV file​

To import the CSV file with user details, follow these steps:

  1. On Engage, click User 360 > Add user > Import users.

  1. Click Upload .csv and add the CSV file that you have created.

  2. In User id, choose the column that contains userId.

  3. In Map CSV headers, associate each CSV header with the corresponding user property. The system also performs auto-mapping of columns based on matching column names and the previous mapping if exists.

    • Select the CSV header that includes userId in the UserId column.
    • Associate each CSV header (column 2) with the User property (column 4).
note

If a CSV header is not mapped to any user property, that CSV column will not be imported.

  1. Click Next.

  2. In Resolve conflicts set the action to be performed to the record when a userIdin the CSV file already exists in User 360. A conflict occurs when the userId imported through the CSV file already exists in User 360.

Retain imported user data​

This replaces the entire user record with the ones available in the CSV file.

  • The existing values will be replaced with the ones in the CSV file.

  • The values will be empty for properties that are either not mapped or not specified in the CSV file.

Update existing user data​

Updates the existing properties of the user with the ones imported through the CSV file. The existing properties that are not specified in the CSV file or not mapped will remain unchanged.

note

If the CSV file has two user records with the same userId, the data will be updated as per the sequence in the CSV file. The user record is updated with the data that comes first in the CSV and then with the ones that comes later. For example, if there are two records with the same userId - one in row 10 and another in row 15:

  • The record is first updated with the data available in row 10.
  • It is then updated as per row 15.

  1. Check Merge tags to retain existing tags and also add new tags in the CSV file if the userId that you are importing already exists. This overrides the behaviour of tags configured in Step 5.

  2. Click Next to proceed.

  3. In Tags, add tags to the entire set of users in the import. By default, a tag with the name {imported_timestamp} - DDMonYY_HH:MM - is added to the import. To add more tags, enter the tag name and press Enter.

  4. To create a segment with the imported users, check Create a segment of imported users based on tags assigned above and enter the Segment name.

note

When multiple CSV files are uploaded simultaneously, it's possible that each CSV file may contain duplicate records.

In cases where there are conflicting records due to duplicated userIds, the total user count within the segment might fluctuate accordingly. However, if records are merged to resolve these conflicts, these merged records may potentially appear in multiple segments.

For example, if you opt to retain user data during a conflict resolution process, the previous record may be deleted, and as a result, it won't be available in the segment that was originally created through the prior import.

  1. Click Import.

You can see the Status of the import.

  • In progress: It states that the import activity is going on. You will see this immediately when you import a CSV file.

  • Completed: It states that the import activity is completed. There could be conflicts in the imported records and you can see that in Failed users.

  • Failed: It states that the import activity has failed due to reasons like incorrect file format or any other technical errors.
note
  • Users are automatically added to the segment every time the user updates to match those conditions.
  • If the userId is not passed in the CSV, yellow.ai creates and assigns an internally generated userId to each user.

Step 3: Analyse import errors​

When importing a CSV file, it is important to analyze any potential errors that may occur:

  • New records: New records will be created with the new userIds provided in the CSV file.
  • Failed records: This can occur due to incorrect column mapping, data type mismatches, or other errors that prevent the addition or updating of users.

To ensure data accuracy, it is important to carefully review and address any import errors that arise.

To see errors in the import:

  1. On Engage, go to User 360.
  2. Click Add users > Import users.
HeaderDescription
File uploadedName of the imported file.
Uploaded DateDate when the file was uploaded.
Total usersTotal number of user records in the CSV file.
New usersTotal number of new user added through the import.
Conflicting usersTotal number of user records in the CSV file that conflicted with the existing users in User 360.
Failed usersNumber of user records that couldn't import.
Empty recordsNumber of empty records that were identified in the imported file.
TagsUser tags associated with all the users of the import. This includes the default tag and any other tags that were added on Add tags and segment users screen.
User segmentSegment created with the user list on the Add tags and segment users screen.
StatusStatus of the import - In progress, Completed, or Cancelled.

  1. Navigate to the import for which you want to download the error report and click . The downloaded Excel file contains includes the following information.

The following sections provide descriptions for each column in the error report.

Summary​

The summary report provides information on the count of user records based on their status, including newly added, failed, and merged records.

  • New users: Records that were imported as new users.

  • Updated records: Properties or fields that were merged into existing records.

  • Failed records: Records for which import failed. You can see information on the specific errors encountered as mentioned in the following:

    • BOT_ID: Bot ID for which the CSV was uploaded.
    • REQUEST_PAYLOAD: The user record for which an import was attempted but FAILED.
    • ERROR_PAYLOAD: The error details due to which the above user import FAILED:
    • invalidDataType: Properties for which the wrong data type was passed.
    • invalidProperty: Properties that do not exist in the user table.
    • propertiesRequired: Mandatory properties that are missing in the CSV file.
    • LINE_NUMBER: The row number of the user record for which import FAILED.

What's next?