Skip to content

Base Configuration

Email Recommendations requires a base configuration before templates and campaigns can be created. The Configuration tab is only available to users with Email app Admin access. The default settings are used on all markets. Custom market settings can be configured for the product URL template and the exclude products filter.

Email Recommendations - Getting Started - Configuration tab


All intended users of the Email app must have access set in the Admin app to both the Email app and the markets that the users will use Email Recommendations with. It is recommended that Email app users are familiar with HTML and CSS syntax to create product templates. Mustache templates are used to enable inclusion of attributes from Apptus eSales.

General settings

Default market

Sets the default market used for Email Recommendations.

Image dimensions

The recommendation image dimensions can be set to either Use original size or Scale where a fixed width and height will be the default.

Product URL settings

A product URL template is required, as is a timestamp. A customer key can also be added as a variable to a product URL. The format of the variables are dependent on the template formatting of email service providers. The campaign ID from an email service provider can also be used.

Product URL template

The product URL template schould describes the complete URL to the products in the mail recommendations and uses Mustache. The product data contains a relative path to the products, meaning that the domain of the retailer's site must be provided to form complete product url's. Typically the value will look like this:{{product.url}}


The timestamp is a required URL parameter. It is used to ensure that new images will be generated when consecutive emails with the same template id have been sent to an end customer. The timestamp is based on UNIX epoch time.

Customer key

The customer key is used as a URL parameter to enable personalised recommendations. If omitted or no customer key is found, top selling products will be returned. The customer key must match the customer keys used in Visitor Identification on the site.

Use ESP campaign ID

An ESP campaign ID consists of a property name and a property placeholder based on the requirements from an email service provider. A retailer must verify with their Apptus contact that they can use an ESP campaign ID before adding a property name and property placeholder in the Email Recommendation settings.

The ESP campaign ID must change dynamically for each sent mail in a campaign. A campaign must be published with a timestamp before the ESP campaign ID can be used with it.

UTM tags configuration

Parameters for additional UTM tags can be configured to automatically be included in URLs.

Product exclusions

A global product exclusion can be set to always leave out a specified set of products in the recommendations. This feature is useful when certain products are not in season, for example winter clothing in the summer, or in general is deemed not desired for recommendations, such as products below a certain price range, gift cards, or spare parts.

The exclusion filtering is based on the existing product attributes in a retailer's eSales cluster and can have multiple rule sets, each with several exclusion layers of products. The global product exclusion will override any campaign product inclusions.

Email Recommendations - Getting Started - Excluded products

Email campaign template

A template for the whole email. It allows to set up CSS styles, iterate over blocks and product positions, and make conditions based on the blocks types. The template in the default configuration is optional and can be overwritten in the market configuration and in the campaign, as well as be reverted to when needed. For more information, see Email template preview and edit and Email template model.

Email Recommendations - Base Configuration - Email Campaign Template

Update configuration

The configuration can be updated at any time. The new configuration will be applied within 5-10 minutes. Be aware that changes will affect active campaigns. Already opened emails will not change the product set, but product URL's will lead to a different location if the product URL template is changed.

Last update: March 25, 2022
Back to top

This online publication is intellectual property of Apptus Technologies. Its contents can be duplicated in part or whole, provided that a copyright label is visibly located on each copy and the copy is used in conjunction with the product described within this document.

All information found in these documents has been compiled with utmost attention to detail. However, this does not guarantee complete accuracy. Neither Apptus Technologies nor the authors shall be held liable for possible errors or the consequences thereof.

Software and hardware descriptions cited in these documents might be registered trademarks. All trade names are subject to copyright restrictions and may be registered trademarks. Apptus Technologies essentially adheres to the manufacturer’s spelling. Names of products and trademarks appearing in this document, with or without specific notation, are likewise subject to trademark and trade protection laws and may thus fall under copyright restrictions.