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.
Once set, a property's data type cannot be changed. API calls attempting to set or update an existing field with a value that cannot be coerced into the appropriate type will fail.
This section describes two ways to add fields to an Iterable user profile:
Uploading a CSV file
You can import users with their user profile fields if you have a CSV file where one column (
For more information, read Adding Users and Creating Lists and CSV List Import Best Practices.
Using Iterable's API
POST /api/users/updatepassing user profile fields in the
dataFieldsobject 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:
User profile fields are case and space sensitive. To insert a user profile field that contains spaces, use the following syntax:
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
ip (IP address) for a user causes Iterable to add
timeZone fields as well.
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
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
category, etc. These fields can all be used in Iterable message
A call to
removes all the
shoppingCartItems on a user's profile.
Please sign in to leave a comment.