Using the email template builder

The email code editor allows you to:

• create email templates from scratch and edit them by using HTML.
• create email templates to be edited in an easy-to-use configuration form that doesn’t require programming skills.
• use the ready-made templates from the Predefined dynamic templates folder as a base for your own designs

The folders with predefined templates provide you with templates for the most common campaign scenarios such as AI recommendations, abandoned cart, recommendations based on the context of the last seen item, and so on.

Using the predefined templates doesn’t require making changes to the template code. The template builder contains a user-friendly configuration form for defining the properties of the template. This makes editing templates possible by any user, regardless of their programming skills.
You can also simplify the editing of your own templates by creating a custom configuration form adjusted to your needs. Thanks to this, you can edit your template or create its variations dedicated for different scenarios.

You can personalize the content of the message by using inserts. Inserts allow you to refer to customer attributes (such as name, city, size), product recommendations (for example, last seen items or added to a cart), and the results of aggregates, expressions, and metrics.

Additionally, when you create an email template from scratch, the HTML section contains a default email structure.

Tips before you start

• You can create an email template directly while sending an email. However, because of the approval procedure, it is more convenient to create a template and have it approved before defining the settings while sending an email as it speeds up the process of creating the email.
• While creating the template, save your template once in a while because there is no auto-save option.
• Although Synerise automatically adds the unsubscribe header, always add the resignation link to the template - without it, the emails may reach the spam folder.
• The View in browser link doesn’t work in the preview. You must send a test email to test such links.
  Important: We do not recommend adding a View in browser link to templates that contain a reference to Automation event context (event.params.{paramName}) because previewing such messages is not supported.
• For better template organization, you can create template folders:
  1. Go to Communication > Email.
  2. On the left side, click Templates.
  3. Select From template tab.
  4. Scroll down to the bottom of the page.
  5. Click Result: A pop-up appears.
  6. On the pop-up, in the Folder name, enter the name of the folder.
  7. Confirm by clicking Apply.

Editing a predefined template

This section describes how to edit the predefined templates (static and dynamic). As a result of editing a predefined template, a copy of a predefined template will be created. Overwriting a predefined template is impossible.

1. Go to Communication > Email.
2. On the left pane, select Templates.
3. From the list of template folders, select Predefined dynamic templates.
4. Select one of the templates to edit.
   Result: You are redirected to the code editor.
5. You can edit the template in two ways:
   • Edit the code of the template (add inserts, add variables).
   • Go to the Config tab and fill out the form.
6. After you make changes to the template, you can check the preview.
7. When the template is ready, in the upper right corner click Save this template > Save as.
8. On the pop-up:
   1. In the Template name field, enter the name of the template.
   2. From the Template folder dropdown list, select the folder where the template will be saved.
   3. Confirm by clicking Apply.

Creating a template

1. Go to Communication > Email.
2. On the left pane, select Templates.
3. In the upper right corner, click New Template.
4. Use the HTML tab to define the properties of the template.
5. When the template is ready, in the upper right corner click Save this template > Save as.
6. On the pop-up:
   1. In the Template name field, enter the name of the template.
   2. From the Template folder dropdown list, select the folder where the template will be saved.
   3. Confirm by clicking Apply.

Adding an insert to the template code

To use data such as analysis results or product recommendations in the code of the template, use Inserts available on the upper right side of the preview.
Read more about how you can use inserts in communication with customers.

1. Click Inserts.
   Result: A pop-up shows up.
2. From the dropdown list, select the type of the insert.
   Result: A list of inserts of the selected type opens.
3. Click the insert you want to add to the template.
   Result: A field with the Jinjava code appears.
4. To copy the code to the clipboard, click the icon on the left side of the field.
5. Paste the code into the code of the template.

Template editing simplification

To make your template more accessible to users without programming skills, you can add a configuration form with variables dedicated for the template, so the user can make adjustments to the template.

The effect of template editing simplification is that you can edit templates by filling out a user-friendly configuration form (available in the Config tab) whose fields define the value for each property of the template.

The process of template simplification involves replacing values with variables in the HTML elements, such as alignment, font, color in CSS, or HTML tags as title, description or buttons. You can also add a variable in the place of Jinjava elements, such as a recommendation campaign ID, voucher pool ID, or catalog name. Variables inserted in the code appear in a form the Config tab when editing the template.

List of variables

You can use the following variables:

• String - Allows you to add a field that requires a string value.
• Select - Allows you to add a dropdown list with configurable values.
• Synerise insert select - Allows you to add a dropdown list with aggregates, expressions, metrics, voucher pools, and recommendations.
• Switch - Allows you to add a field which is enabled/disabled by a toggle.
• Color - Allows you to add a color selector. You can either select a color or enter its code manually.
• Number - Allows you to add a field that requires a number. You can either select a number from a dropdown or enter it manually.

While inserting a variable in the code, you must define the ID of the variable, select the type of the variable (if you chose the Select type, you must define the scope of values available in the dropdown) and define a default value. Optionally, you can add a label and description.

Results of simplifying template editing

Instead of modifying the design of the template directly in the code, a user can go to the Config tab and define the properties of the template by filling out configuration form.

The image below presents the easy-to-edit form that lets users without coding expertise change the variable values:

Adding a variable

1. Select the HTML tab.

2. Find a property to which you want to add a variable.

3. On the right side, click Variable.
   Result: A sidebar appears.

4. In the Identifier field, enter the ID of the variable.
   This will be the title of the field unless you define the Label field.

5. From the Type dropdown list, select the type of variable.
   

   StringSelectSynerise insertSwitchColorNumber

   Allows you to add a field that requires a string value.

   1. In the Label (Optional) field, enter the name of the field.
      If this field is empty, the name of the field will be taken from the Identifier field.
   2. In the Description (Optional) field, enter a short explanation of the field’s purpose.
   3. In the Default Value field, enter the default value.

   Allows you to add a dropdown list with configurable values.

   1. In the Label (Optional) field, enter the name of the field. If this field is empty, the name of the field will be taken from the Identifier field.
   2. In the Description (Optional) field, enter a short explanation what this field is for.
   3. In the Display Name field, enter the name that will be visible in a dropdown.
   4. In the Value field, enter a value.
   5. In the Default Value field, enter the default value.

   Allows you to add a dropdown list with aggregates, expressions, metrics, voucher pools, and recommendations.

   1. In the Label (Optional) field, enter the name of the field. If this field is empty, the name of the field will be taken from the Identifier field.
   2. In the Description (Optional) field, enter a short explanation what this field is for.
   3. From the Insert Type dropdown list, select one of the following options: Aggregates, AI Recommendations, Expressions, Metrics, Voucher pools.
      As a result, in the configuration form, you will be able to select a particular object (for example, an aggregate) from a dropdown list.
   4. In the Default Value (Optional) field, enter the default value.
      Result: A dropdown with the insert is added to the form in the Config tab. From the dropdown list, you can select an item of the chosen type (for example, aggregates). As a result, the value of variable will be ID of the selected item.

      

   Allows you to add a field which is enabled/disabled by a toggle.

   1. In the Label (Optional) field, enter the name of the field. If this field is empty, the name of the field will be taken from the Identifier field.
   2. In the Description (Optional) field, enter a short explanation what this field is for.
   3. In the Default Value field, select the default value (true/false).

   Allows you to add a color selector. You can either select a color or enter its code manually.

   1. In the Label (Optional) field, enter the name of the field. If this field is empty, the name of the field will be taken from the Identifier field.
   2. In the Description (Optional) field, enter a short explanation what this field is for.
   3. In the Default Value field, enter the default value.

   Allows you to add a field that requires a number. You can either select a number from a dropdown or enter it manually.

   1. In the Label (Optional) field, enter the name of the field. If this field is empty, the name of the field will be taken from the Identifier field.
   2. In the Description (Optional) field, enter a short explanation what this field is for.
   3. In the Default Value field, enter the default value.

   

6. Optionally, to modify the order of variables appearing in the configuration form, add the order parameter to the variable formula (for example, #### type: "string", id: "string", label: "Text", order: 1 !####).

7. In the upper right corner, click Add.
   Result: In the template code a variable will appear (it starts with ####)

Previewing templates

5. To check the preview of the template for a particular profile, click the Preview contexts button on the upper left side.
6. Enter the ID of a profile.
7. Click Apply.