User Profile Fields

User profile fields are fields stored on a user's profile. They contain information that you know about the user, such as demographic data and preferences.

# Table of contents

# Data types for user profile fields

Each field on a user profile has an associated data type: string, boolean, double, long, date, object, or array.

# Importing users

This section describes two ways to add fields to an Iterable user profile:

1. Uploading a CSV file

   You can import users with their user profile fields if you have a CSV file where one column (email) represents the user's email address, and other columns represent user profile fields. Uploading a CSV with new values for existing user profile fields will overwrite the existing fields.

   For more information, read Adding Users and Creating Lists and CSV List Import Best Practices.

2. Using Iterable's API

   Calling the POST /api/users/update passing user profile fields in the dataFields object will add or update those fields on the user's profile in Iterable.

   For more information, read API Overview and Sample Payloads.

# Viewing a user's profile in Iterable

To look up a user by email address, navigate to Audience > Contact Lookup.

# Inserting user profile fields in messages

To insert user profile fields into an Iterable message template, use double curly braces. For example, if a user profile has a firstName field, use the following syntax to insert that field:

{{firstName}}

{{[first name]}}

Templates can include user profile fields, event properties, data feeds, and Catalog data. For more information, read Personalizing Templates with Handlebars.

# User profile fields managed by Iterable

Iterable offers some built-in profile fields, detailed in User Profile Fields Used by Iterable

Providing an ip (IP address) for a user causes Iterable to add city, country, state, and timeZone fields as well.

Setting the ip or timeZone field on a user profile also allows for messages to be sent at a specific local time. For more information, read Creating Blast Campaigns.

# How the commerce API affects user profiles

The POST /api/commerce/updateCart/ API is designed to be used whenever a user adds an item to a shopping cart. It adds the the shoppingCartItems to the user profile as a field. Each shoppingCartItem can contain other attributes such as price, quantity, sku, category, etc. These fields can all be used in Iterable message templates.

A call to POST /api/commerce/trackPurchase removes all the shoppingCartItems on a user's profile.