Prepare a CSV file to import user data

When importing user data with a CSV upload, you will need to include certain fields as columns in the CSV file you upload. Depending on the type of data you want to import, the format of the column may look different.

For more on how to format your CSV file based on the type of data you want to import, click on what you would like to import below:

• User attributes
• Device attributes
• Events
• Email unsubscribe/resubscribe

🚧

Check the file encoding

Before uploading, it is best practice to check the file's encoding to ensure it is encoded properly Check to see if it has Byte Order Mark and if it does you will need to encode simply as "UTF-8".

To check the encoding, you can open the file in Sublime Text and click in the menu File > Save with Encoding > "UTF-8" (not "UTF-8 with BOM").

User Attributes

When uploading new users and/or user attributes, it required your CSV include the user ID in the first column. Any attributes you want to upload will be in the following columns. You are also able to include the user's created date (unix) and lastActive time.

Uploading an Email attribute

If you have activated email with Leanplum, you will need to upload the email addresses for all your users. When uploading your csv file, make sure your users' email addresses are included as an attribute in the CSV file. Otherwise, Leanplum will not be able to email these users.

Example file format:

The above sample file will create a user profile like this:

📘

Email Attribute

When uploading the email attribute, make sure the name of the attribute matches the attribute name you have set in your email settings. This attribute will be used to store the email address and used to send the email.

For more on this visit our email setup doc

Device attributes

To upload device-level attributes, you can do so by including all the below fields when uploading. When you are uploading the file, you must include the user ID if there is one and the device ID so we can properly capture under the user.

🚧

Use the right API action

When importing device attributes, you must set the defaultAction to setDeviceAttributes in the API call.

Example file format:

Events

When formatting your CSV for event uploads, you can import information on the number of occurrences of an event, the value of an event, the time an event first occurred, and more.

🚧

Use the right API action

When importing historical events, you must set the defaultAction to setUserAttributes in the API call.

Example file format:

This sample creates a profile like this:

Now you can segment users based on the number of occurrences of the event in the Users page. For example:

Email unsubscribe / resubscribe

Use the information below to create a CSV that unsubscribes or subscribes a list of users for email.

Managing subscribing/unsubscribing for the Email channel:

Example file format:

Managing subscribing/unsubscribing for Email Categories:

Example file format: