Iterable-specific user profile fields

Iterable automatically creates and maintains some field on each user's profile. In most cases, these fields do not need to be edited by the client, and there's no need to include them when updating a user's profile. All of these fields are case sensitive and space sensitive.

# Reserved fields

The following fields will be ignored by Iterable (i.e. no changes will be made to the field value) if passed in a user update call:

• campaignId
• channelId
• eventName
• messageTypeId
• templateId
• total

# Fields that Iterable manages

These fields do not need to be included in any updates to the user profile, nor should they be overwritten.

# email

email is the email address of a user. The data type is String.

# profileUpdatedAt

profileUpdatedAt is the date the user profile was last updated, either via CSV upload or API call. The data type is Date and the format looks like "2016-08-02 18:53:45 +00:00". For more information, read Data field types in Iterable.

# signupDate

signupDate is the date when the user profile was created in Iterable. The data type is date, and the format looks like 2016-08-02 18:53:45 +00:00. For more information, read Data field types in Iterable.

# signupSource

signupSource is how the user entered the Iterable database. Includes options like API or IMPORT. The data type is string.

# emailListIds

emailListIds is an array of integers, each representing a list to which the user belongs. Whenever a user is added to a new list, Iterable will update this array.

# unsubscribedChannelIds

unsubscribedChannelIds is an array of integers, each representing a channel to which the user has unsubscribed. Users will not receive messages associated with types belonging to channels from which they have unsubscribed.

# unsubscribedMessageTypeIds

unsubscribedMessageTypelIds is an array of integers, each representing a message type from which the user has unsubscribed. Users will receive messages from opt-out message types only if they have not unsubscribed from those types or their associated channels.

# subscribedMessageTypeIds

subscribedMessageTypelIds is an array of integers, each representing a message type to which the user has subscribed. Users will receive messages associated with opt-in message types only if they have subscribed to those types and have not unsubscribed from the channels associated with those types.

# createdAt

createdAt indicates a timestamp of when the event was indexed into Iterable. This field can be updated via API, though one thing to note is the value will need to be in Unix timestamp, instead of an ISO-formatted string.

# Special fields

All of these fields are case sensitive and space sensitive. For example, phone_number will add a separate field to your users' profiles; it will not allow Iterable to send SMS to them.

# email

email is the email address of a user. This field is a string.

# phoneNumber

phoneNumber is the phone number of the user, used to send SMS messages. The data type is String and the format looks like 16503926753. To learn more about SMS requirements, read SMS Overview.

# devices

devices is an array of objects of the user's devices, used for push notifications. Each object in the array must include at least the following fields: platform, token, and applicationName.

To learn more about push notifications, read Sending Push Notifications.

This field must be added by calling the /users/registerDeviceToken API endpoint.

# ip

If ip is included on a user profile, Iterable will, by default, add and update fields on the user profile for city, state, regions, and timeZone. These fields can be edited if desired, but Iterable will update and overwrite them if ip is updated, which can happen when a user opens or clicks on an email. This setting can be adjusted by going to Settings > Project Settings. These fields are all strings.

Including ip or timeZone will allow messages to be sent at a user's local time.

ip can also be automatically added to the user profile by Iterable if you toggle on Automatically Update IP in User Profile from Inbound Events in Settings > Project Settings. We will detect the user's ip from email click events and add it to the user profile.

# locale

locale is used to represent which language preference a person should receive when send a message. You can create multiple versions of a template, one for each locale, while maintaining the same templateId. The value of locale should be a string, and should be the two-letter ISO country code for the language desired. These will correspond to the options you add to the locales section of your project's settings.