Configure Email Template

You can create a Email template from scratch or by using an existing template.

Creating a new email template from scratch

  1. Navigate to Creatives, section > Email tab, click Create New.
  2. In the Creative name, enter the name for the Email template.
  3. Select the mode for creating the template. You can either upload a ZIP file containing the HTML and images for the template, upload an HTML/HTM file, or start configuring the template using the editor. You can upload a file with a size limit of up to 5MB.
  4. Select Start from Scratch.
  5. Enter the subject and configure the Email body.
  6. Click Create. To see a preview, select Preview and Test.

Creating a new email template using existing template

To create a new email template using existing template follow the given steps:

  1. Navigate to Creatives, section > Email tab, and from the list of existing templates, choose the desired template and click on Edit.
  2. Update the subject and modify the email body as per needed.
  3. Click update. To see a preview, select Preview and Test.

The email template is edited successfully.

Configuring the Email body content

  1. In the editor, Drag and drop the required blocks from the Content tab and the Row tab and add the content as required. You can perform the following:

    • Edit text with labels and tags and apply formatting. Unsubscribe tag is mandatory for all the Email content. You can also customize the Unsubscribe message's landing page using Vulcan.
      Note: Make sure that all tags contain data. Inconsistency in the tags will result in a validation error.

    • Add images

    • Personalize the message using Liquid language.Add dynamic headers and footers. You can also use the organization custom field to use dynamic header, footer etc according to the organization. This can help in a connected org set-up. Refer to the documentation here.

    • Add Barcode which will have the customer's loyalty identification information. This can be included in the email during a customer registration email or any other updates or campaigns in the email. For more information on barcodes, refer to the barcode documentation.

  2. Click the Settings tab and adjust the content area, color, alignment etc.

  3. Click Create. To preview the content, click Preview and Test.

Rows tab

To design the layout, click the Rows tab on the right panel, drag, and drop it to your preferred position on the mail body. Similarly, you can add more rows as required. There are various rows available each with a different dimension.

Content tab

Use the Content tab to add text, images, buttons, divider, social network links, HTML code, videos, and more to the email body (each row). Drag and drop the required content block to the desired position in the body.

Content Blocks

BlockDescription
TitleTo include a title.
ParagraphTo add text. This is similar to the text block.
ListTo add a list.
TextTo include a text message.
ImageTo add images from the library or your local system.
ButtonTo add action buttons such as Click here, Submit.
DividerTo add columns to a row (divide a row into columns).
SocialInclude Social Channel icons to navigate recipients to the organization's social platforms. You need to link the respective URLs for each social channel icon (Facebook, Twitter, Instagram, and LinkedIn).
HTMLTo insert HTML code blocks in the template. For example, HTML tags, headers, hyperlinks, and more.
VideoTo embed a video in the email. Add a video embed link in the input box. For example, you can embed a video representing specific information about the brand or product or brand ad.
IconTo add an image icon in the email body. An icon, a small image, or a symbol is usually used for the brand or product logos. \<br>\ Add an icon from the library and modify it as required.
MenuTo insert a menu bar in the email body. A menu is a navigation bar with links to each menu option. You can configure multiple menu items if required.
StickersTo include stickers from the library.
GIFSTo add animated images or GIFS from the library.

Block Options

Content PropertiesDescription
PaddingUse to add an additional margin to the content on all sides (Overall) or each side of a box - Right, Left, Top, and Bottom.
Hide onHide on feature enables you to show the content on your preferred form factor. You can choose to hide content either on desktop or mobile.
  • Toggle between code view and normal view
    To switch to the code or editor mode, hover the mouse and click Switch editor.
📘

Note

In code mode, you can only see editor design email using HTML code. Repeat the previous step to switch back to Drag-N-Drop editor mode.

📘

Note

After selecting the content block, you can view all the content properties and block options to modify the content.
For example, Font style, Font color, Bold, Italics, Alignment, Add bullets, etc.

Settings

BlockDescription
Content area widthSets the width of the main content section in the email.
Content area alignmentAligns the content area to the left and center.
Background colorSets the overall background color of the email.
Content are background colorSets the background color specifically for the content area.
Default fontSets the font of the text.
Link colorSets the color of all hyperlinks in the email.

Barcode in Email

This feature enables you to create a barcode that contains customer identifier information and can be used by customers for identification purposes. Customers can use this barcode at the POS to identify themselves and earn/claim loyalty benefits.

📘

Note

  • Barcode feature is not enabled by default. Create a JIRA ticket to the sustenance team to enable the feature.
  • Barcode feature can be used both in Loyalty programs and on Engage+.

Prerequisites to enable barcode

  1. To enable barcode generation, the following configurations must be enabled:

    1. CONF_REGISTRATION_BARCODE_GEN_ENABLED: Set the value to 0 or 1. Default value: 0- False
    2. CONF_BARCODE_VALUE_IDENTIFIER: Set the value to 0,1 or 2 to set the barcode identifier. You can set the identifier according to the information to embed in the barcode.
ValueDescription
0Mobile number of the customer.
1Email ID of the customer.
2The external ID of the customer.
  1. Raise a Jira ticket assigned to the Foundation team and enable bucket, namespace, and CDN URL support for the barcode service on the respective cluster where the organization is located.

Configuring barcode

Capillary supports six types of barcodes, given below:

  • ITF
  • PDF417
  • EAN 13
  • UPC A
  • QR code
  • CODE 128

Default barcode configuration

Field

Value

Default barcode type

CODE_128

Image type

PNG

Default barcode styles<br>according to the barcode type:

-ITF

  • Barcode text: Disabled[<br>-Image height: 200<br>- Image width: 400

-QR_CODE

  • Barcode text: Disabled\<br>- Image height: 200\<br>- Image width: 300<br>- Image width padding: Enabled<br>- Image height padding: Enabled

-PDF_417

  • Barcode text: Disabled<br>- Image height: 200 <br>- Image width: 300<br>- Image width padding: Enabled<br>- Image height padding: Enabled<br>- Font size: 5

-EAN_13

  • Barcode text: Disabled<br>- Image height: 200<br>- Image width: 300<br>- Image width padding: Enabled<br>- Image height padding: Enabled<br>- Font size: 5

-UPC_A

  • Barcode text: Enabled<br>- Image height: 200<br>- Image width: 300<br>- Image width padding: Enabled<br>- Image height padding: Enabled<br>- Font size: 5<br>- Font name: Arial

-CODE_128

  • Barcode text: Disabled<br>- Image height: 200<br>- Image width: 300<br>- Image width padding: Enabled<br>- Image height padding: Enabled<br>- Font size: 5<br>- Font name: Arial
FieldData TypeDescription
default_barcodeStringDefault barcode type that will be used if no barcode type is mentioned in the barcode service API.
showBarcodeTextBooleanIf set to true, the text will be displayed with config.
imageHeightIntegerHeight of the image in pixels.
imageWidthIntegerWidth of the image in pixels.
imageWidthPaddingIntegerPadding around the width of the barcode image. This property is applicable when showBarcodeText is set to true. Not applicable for ITF barcode.
imageHeightPaddingIntegerPadding around the length of the barcode image. This property is applicable when showBarcodeText is set to true. Not applicable for ITF barcode.
fontNameStringName of the font. Not applicable for EAN 13, PDF417, QR Code, ITF barcode.
fontSizeStringSize of the font. Not applicable for ITF and QR code.

To edit the default barcode configuration, create a JIRA ticket to the Capillary sustenance team.

Generating barcode

According to the configuration, during customer registration, the Customer Add API calls the barcode service and the barcode image is stored in the images table in the backend. If the identifier provided in the configuration is changed using customer identifier change API, a new barcode image is created and saved. You can retrieve the barcode image details using the GET customer details API.

📘

Note

If you want to create a barcode for an existing user or regenerate a barcode, create a ticket to the Sustenance team.

To embed the barcode in the email creative, perform the following:

  1. Navigate to the Engage+ homepage, and select the campaign to send the email creative.
  1. Click New message to create a new email creative.
  1. In the Content block, click Add creative.
  1. Navigate to the Email tab and click Create new.
  1. Click Create using editor and click Continue.
  1. Select a template of your choice.
  1. In the email body, click Add label and select Customer barcode label.
  1. Embed the {{customer_barcode}} tag in your email template.

A barcode has been generated for the customer. A broken image is sent to the customer if a barcode fails to generate.

Preview and test Email

You can use the preview and test options to verify the email content and design before sending it to your audience.

  • Preview: View the email content and design before saving.
  • Test message: Send test messages from the email test message section to selected test customers or test groups to review the content and design before sending to the audience.

Previewing and testing an email message

To preview and test an email message, follow the steps below.

  1. Create a new email template and add all the required tags to the template.
  2. Select Preview and test. The application lists all tags in the template.
  3. You can also include the custom tags in the preview. To include custom tags, perform the following:
    1. Select Enter custom value for tags. An input form appears with input boxes for all the tags in the template content. The tags for which the values are static are mandatory. For example, tags such as voucher_expiry_date, store name, are mandatory and are marked with an asterisk (*) where as the static fields such as first name, registered_store_name are always not mandatory.
    2. Add the values for the tags. You can add the values automatically or manually.
      1. To fetch the values automatically, navigate to the customer search box and search for a customer by using mobile number, email, or external ID. Once a customer is selected, all user-specific tags are automatically filled with that customer's data. The customer should have the values defined in their profile for the fields to populate the values automatically. Else, an error message will appear.
      2. To add the values manually, add the values against each tags. You can also select Show JSON Enter values for these tags in the JSON.
  4. Select Update preview. The email content appears on the right with all tag values filled.
  5. To discard, select Discard custom values. You can click either of the two layouts to view the email in desktop or mobile views.
  1. After updating the preview, select Send test messages. You can select individual test customers, test groups or select multiple test groups to send messages. The available test users are retrieved from the test customer configurations defined at the organization level. For more information about test messages, refer to Test Journey documentation.
  2. Click Send test message. The message will be sent to the selected users.

Customize Unsubscribe landing page

You can customize the default unsubscribe landing page using Vulcan. To request customization, connect with your Customer success executive.

You can customize the following elements:

  • Brand logos
  • Custom text or messaging
  • Language-specific versions

An example of how the unsubscribe landing page will look when customized for French language.

Troubleshooting email image quality issues

👍

Notes

  • Do not forcefully enlarge images.
  • Use actual images or image URLs in zip files without enlarging them.
IssueResolution
File size is getting reducedExpected behavior. File size reduction due to image transformations does not affect user experience. Specify image dimensions to maintain quality. <br>For example, if the email specifies a height and width of 200 x 300, images are transformed to match these dimensions instead of saving the original image, which might have very high dimensions. Consequently, the file size is reduced. This reduction could also occur due to dynamic image quality adjustments based on file sizes.
Image getting compressed excessivelyCompression varies with file size. Smaller images have less compression; larger images undergo higher compression. This makes sure that irrespective of the file size, similar quality of images is achieved after compression. Do not artificially enlarge images to increase the file size.
Images saved in avif format instead of jpegImages are saved in their actual format except when the device supports avif format. avif format enables saving the images in smaller file sizes without impacting image quality.

For information on Generate OTP APIs, refer to the API documentation.