Each Emarsys account comes with a number of predefined system fields in the database. Here you can find a list of these fields, their type and ID, as well as a complete list of the single-choice fields and their respective values. These may be required when setting up automated data transfer between the Emarsys application and another application or web resource.
Specific field details
Introduction
The ID and the string ID of the system fields are also displayed on the left of the table in the Field Editor.
You can create your own custom fields from the application interface or via the API. With the API you can also query the list of fields.
- When using the API to update fields, you cannot update any of the fields marked as read-only in the table below.
- Do not add emojis to the Emarsys System Fields. These are not supported and will lead to loss of data for those fields.
- Click here for a list of the available field types.
- Click here for a list of the IDs and values for single-choice fields.
Emarsys System Fields and their IDs
| Field Name | ID | Values | Type | Example | Read-only |
|---|---|---|---|---|---|
|
Interests |
0 | interests (multi-choice) | shoes | Yes | |
| First Name | 1 | short text | Max | No | |
| Last Name | 2 | short text | Mustermann | No | |
| 3 | long text | Max.Mustermann@mustermann.at | No | ||
| Date of Birth | 4 | date (birthdate) | 1970-05-26* | No | |
| Gender | 5 | yes | single choice | Male | No |
| Marital Status | 6 | yes | single-choice | Married | No |
| Children | 7 | yes | single-choice | 0 | No |
| Education | 8 | yes | single-choice | Bachelor | No |
| Title | 9 | yes | single-choice | Dr. | No |
| Address | 10 | long text | 12 Straight Street | No | |
| City | 11 | short text | Hometown | No | |
| State | 12 | short text | Home State | No | |
| ZIP Code | 13 | short text |
1234 | No | |
| Country | 14 | yes | single-choice | Austria | No |
| Phone | 15 | short text | +123454445 | No | |
| Fax | 16 | short text (fax) | +123454446 | No | |
| Job Position | 17 | yes | single-choice | Management | No |
| Company | 18 | long text | Emarsys | No | |
| Department | 19 | yes | single-choice | e-commerce | No |
| Industry | 20 | yes | single-choice | Marketing | No |
| Phone (office) | 21 | short text | +123454447 | No | |
| Fax (office) | 22 | short text (fax) | +123454448 | No | |
| Number of Employees | 23 | yes | single-choice | 10-49 | No |
| Annual Revenue (in 000 EUR) | 24 | yes | single-choice | 250-499 | No |
| URL | 25 | URL | www.emarsys.com | No | |
| Preferred e-mail format | 26 | yes | single-choice | HTML | No |
| Avg. length of visit (minutes)** | 27 | numeric (special) | 5 | Yes | |
| Page views per day** | 28 | numeric (special) | 1,000 | Yes | |
| Days since last email sent** | 29 | numeric (special) | 30 | Yes | |
| Response rate** | 30 | numeric (special) | 30% | Yes | |
| Opt-in | 31 | yes | single-choice (special) | Using the API: 1 (True), 2 (False) Empty (NULL) | No |
| Using Forms: y (True), n (False), Empty string (NULL) | |||||
| Contact source | 33 | yes | single-choice (special) | Manual | Yes |
| Contact form | 34 | yes | multi-choice (special) | Newsletter 1 | Yes |
| Registration language | 35 | yes | single-choice | English | No |
| Newsletter | 36 | multi-choice (special) | (Newsletter names) | Yes | |
| Mobile | 37 | short text | +6801111122 | No | |
| First Name of Partner | 38 | short text | Maria | No | |
| Birth date of Partner | 39 | date (birthdate) | 1975-09-01* | No | |
| Anniversary | 40 | date | 2001-06-30* | No | |
| Company Address | 41 | long text | 1 Company House | No | |
| Zip Code (office) | 42 | short text (numeric) | X4567 | No | |
| City (office) | 43 | short text | Vienna | No | |
| State (office) | 44 | short text | Vienna | No | |
| Country (office) | 45 | yes | single-choice | Austria | No |
| Salutation | 46 | yes | single-choice | Ms. | No |
| Email-valid | 47 | yes | single-choice (special) | Yes | Yes |
| Date of first registration | 48 | date (special) | 2015-05-22* | Yes | |
| IETF language tag |
*** |
short text |
en-US |
Yes |
* The only date format supported by the System fields is YYYY-MM-DD.
** These fields are deprecated.
*** The ID is determined by the system for each individual account.
Admin fields
These fields are added to your account when you enable or purchase a specific product. Their IDs are different for each account and can be found on the Field Editor page (Management menu).
Web behavior fields
The Web Extend data collection scripts update a set of custom fields in your Emarsys account with data related to the activity of your contacts on your website. These fields are updated every few hours.
Although not as extensive in scope as the metrics uploaded to Smart Insight, this data can be used by you to launch targeted product campaigns, such as cart abandonment or stock clearance. We have provided some examples of Automation Center programs using these fields.
Basic fields
If you have only the basic Web Extend setup (not including the e-commerce commands), you will have the following fields updated in your Emarsys account.
| Field Name | Field Type | Description |
|---|---|---|
| predict last session date |
date | The last time the contact interacted with the website, expressed in YYYY-MM-DD format. * Preserved for 7 days. |
| predict last session time spent |
numeric | The duration of the last session, in seconds, maximum 1800 (30 minutes). * Preserved for 7 days. |
E-Commerce fields
If you have the full Web Extend setup, you will also have the following fields updated.
| Field Name | Field Type | Description |
|---|---|---|
| predict last session products | long text | The products viewed in the last session, maximum 10. Note: Entries within this field are separated by pipes |.* Preserved for 7 days. |
| predict last session categories | long text | The categories of the products viewed in the last session, maximum 10. Note: Entries within this field are separated by pipes |.* Preserved for 7 days. |
| predict last session tags | long text | This field is used to store the most recent parameters passed by the Web Extend tag command, maximum 10. Parameters are not deleted and remain until overwritten by new values. The same values can be written multiple times (no deduplication). * Preserved for 7 days. |
| This field must be created manually by you using the tag command, and must be written all lowercase, otherwise it will not be filled. For example, Predict last session tags will not work. | ||
| predict last abandoned date | Date | The date when a product was last abandoned, expressed in YYYY-MM-DD format. * Preserved for 10 days. Examples:
|
| predict last abandoned products | long text | The products abandoned in the cart, maximum 10. Note: Entries within this field are separated by pipes |.* Preserved for 10 days. Examples:
|
| predict last abandoned categories | long text | Categories of products abandoned in the cart, maximum 10. Note: Entries within this field are separated by pipes |.* Preserved for 10 days. |
| predict last abandoned total price | numeric | Total price of all products left in the cart, expressed in the currency of the website. * Preserved for 10 days. |
| predict last purchase date | date | The date of the last purchase, expressed in YYYY-MM-DD format. |
| predict last purchase products | long text | The products bought in the last purchase, maximum 10. Note: Entries within this field are separated by pipes |. |
| predict last purchase categories | long text | The categories of products bought in the last purchase, maximum 10. Note: Entries within this field are separated by pipes |. |
| predict last purchase total price | numeric | Total price spent in the last purchase. |
| predict top categories | long text | For this Predict calculates category preferences based on the most recent categories browsed, but with long-term preferences also taken into account. For new users its usually the same as predict last session categories. * Preserved for 30 days. |
* Certain web behavior fields preserve their values for the predetermined period.
Before this period passes, the value of the field is only updated if the contact triggers the same type of event.
After this period passes, the value of the field is updated if the contact starts a new session (triggers any event visible in the Live Events Viewer).
If a contact does not start new a session after the period ends, the value can be preserved indefinitely.
Please consider these unique features of these particular fields before using them for segmentation. These fields can be more useful for analysing the overall contact base. We recommend using Interactions for interacting with customers.
The 'predict last session tags' is not solely an e-commerce field, since it can also be used by non-ecommerce users who do not have a product catalog embedded in Emarsys.
Data privacy
| Field name | String name | Field type | Description |
|---|---|---|---|
|
Do not track me |
do_not_track_me | single-choice | This allows you to offer your customers an opt-out for tracking their browse behavior. |
Specific field details
Opt-in field
The system field Opt-in (ID = 31) stores the opt-in for email campaigns. The value should only be set to TRUE via a double opt-in process.
Any form of unsubscription by the recipient of an email will set this to FALSE. In cases where email subscription is unknown, the value NULL should be used. This field should not contain an empty string "" when using the API.
For normal marketing emails, only contacts with the value TRUE will receive the email, unless the option Ignore opt-in has been enabled for your account by Emarsys Support.
Some transactional email types will ignore this field, see: Ignoring opt-in for certain transactional emails.
You cannot set the value of this field from FALSE to TRUE via an import or forms, the only method that is allowed is via the API.
Interests field
The system field Interests (ID = 0) is a special multi-choice field which is automatically added to your Emarsys forms. You can use this to collect a standard set of preference information on your new registrations, for example. To create and edit the available options, go to Management > Form Settings > Opt-in invitation and interests.
You can also update the Interests of existing contacts either by exporting them and adding the values externally, or by editing the contacts individually.
The language selected for these options is the Form default language that is selected in your Profile page. If you use forms in multiple languages, you can provide translations of these options. Simply select the target Language, then the Interest field and click Translate.
When you have done this, these translations will appear when you change the language of the form.
Newsletter field
The system field Newsletter (ID = 36) is a special multi-choice field which lists as its values all the Newsletter forms that you have created. When a contact subscribes to a newsletter through such a form, that value is automatically checked for them. If they unsubscribe, the same value is unchecked.
In this way you can keep your subscriptions to individual newsletters independent, both of each other and of the general opt-in.
When you create a newsletter email campaign, you can select Generated through a multi opt-in form as the Recipient source, and then select the opt-in form that collects the subscriptions.
The Newsletter field is not available for segmentation. If you want to create a segment based on one of the newsletter opt-in values, you must create an email campaign for that newsletter form, generate the launch list and save that as a contact list.
You can then segment based on that contact list.
Do not track me field
This field prevents Web Extend from including the contact ID when tracking browse and purchase events on your web shop. It should be used to offer customers the chance to opt-out of this tracking, in accordance with GDPR (for more information, see: GDPR and Web Extend - all you need to know).
Web Extend will still track behavior and send that data to the Predict servers, but there will be no hashed email address or any form of contact ID associated with it. This data will be used to build the statistical models that underpin the Predict product recommendations.
Important notes:
- The
do not track mecustom field has three valuesNULL(default, tracking the contact),1(false) and2(true). To stop tracking, change the field to2. To restart tracking, set the the field to1. The changes will come into effect after 24 hours. - This field stops Web Extend from tracking a visitor as they browse your store. It will not stop any cookies you have implemented from doing the same, nor will it stop your contacts' preferences or sales data being synced to Emarsys if you are uploading that data through another route. If you really want to implement an end-to-end 'do not track me' scenario, you will have to take care of all these other touchpoints as well.
- Opting a contact out of tracking will not mean that they will never receive relevant recommendations. Depending on your business, it can easily happen that an opted-out contact behaves in a predictable way and therefore will continue to see products they have recently viewed. But that is based on Predict's intelligence, not on Web Extend's tracking.
- When a contact is set for Do not track me, all historic, existing and previously collected web behavior related data (Web Extend and Web Channel data) is removed. This affects the reporting of Web Channel campaigns and Predict recommendations, since these contacts will not be tracked anymore. However, it is not affecting Predict and Web Channel historic reporting since that is stored in an aggregated form.
Date of birth field
Campaigns often use birthdays, but sometimes the date of birth in the system is not reliable or empty. In campaigns, the date of birth is treated in the following way:
- Birthdays that are over 120 in the past do not count, the system ignores them.
- Empty birthday fields are also not valid birthdays.
Let's assume that a contact provided the month and the day right, but - as an attempt to disguise their age - entered a year in the 19th century. This contact will not be able to benefit from birthday campaigns.
IETF language tag field
The Multi-Language feature of the VCE editor enables you to send the relevant language version of an email campaign to your contacts. It relies on a system field containing the IETF language code for the given contact.