Contact properties are fields stored on a user's profile.
This document describes:
#Data types for contact properties
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 contact properties if you have a CSV file with one column of emails and other columns of contact properties. Uploading a CSV with new values for existing contact properties will overwrite the existing contact properties.
Using Iterable's API
/users/updateAPI and passing contact properties in the
dataFieldssection will add or update the contact properties on a user's profile.
For more information, read API Overview and Sample Payloads.
#Viewing a user's contact properties
Navigating to Users > User Lookup to look up a user by email address.
#Inserting contact properties in messages
To insert contact properties into Iterable message templates, use double curly braces. For example, if a user profile has a
firstName field, use the following syntax to insert that field:
Contact properties are case and space sensitive. To insert a user profile field that contains spaces, use the following syntax:
Templates can include data from contact properties, event properties, and data feeds.
For more information, read Using Contact Properties, Event Properties, and Handlebars Logic.
#Contact properties managed by Iterable
Iterable offers some built-in profile fields, detailed in Iterable-Specific User Profile Fields
ip (IP address) for a user causes Iterable to add
timeZonefields as well.
timeZone field on a user profile also allows for messages to be sent at a specific local time. For more information, read Scheduling Campaigns for Recipients' Time Zones.
#How the commerce API affects user profiles
/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 contact property. Each
shoppingCartItem can contain other attributes such as
category, etc. These fields can all be used in Iterable message templates.
A call to
/commerce/trackPurchase removes all the
shoppingCartItems on a user's profile.