Email Templates Customization

Overview

This tutorial focuses on customization of transactional emails that are sent to your customers when certain user actions occur (e.g. registering to your service or requesting a password reset) which is possible with the Advanced Customization option (Cleeng-Mailchimp integration).

If you select the Advanced Customization option for your transactional emails, you can build an email template from scratch using the visual editor in Mailchimp and adding Cleeng data variables (parameters) in the template content.

Cleeng parameters work like Mailchimp merge tags. For more information on how Mailchimp merge tags work, see Mailchimp documentation.

In Cleeng, we have two kinds of parameters that you can use to insert personalized or dynamic content in your emails:

  1. Global Parameters
  2. Specific Template Parameters

For example, you can use the CUSTOMER_FIRST_NAME parameter to display a customer’s first name where the parameter is placed. You can paste it anywhere you want in the html file, it can be either a value for parameter or value in the text tag like in the example below.

Note: Please pay attention to the formatting of parameters as specified in the Mailchimp documentation for merge tags.

<b>Hi *|CUSTOMER_FIRST_NAME|*,</b>
"Welcome email" example

"Welcome email" example

Global parameters

They are used in every template to reflect a broadcaster’s branding and data of a specific customer that an email is sent to.

ParameterTypeDescription
CUSTOMER_FIRST_NAMEstringCustomer’s first name
CUSTOMER_EMAILstringCustomer’s email address
PUBLISHER_NAMEstringBroadcaster’s name
ACCOUNT_URLstringAccount link
TERMS_URLstringTerms & Conditions link
PRIVACY_URLstringPrivacy Policy link
CURRENT_YEARnumberCurrent year
PUBLISHER_LOGOstringBroadcaster’s logo set by the broadcaster in the dashboard’s brand settings
PUBLISHER_MAIN_COLORstringMain color set by the broadcaster in the dashboard’s brand settings
PUBLISHER_BACKGROUND_COLORstringBackground color. The value is fixed: #F2F7FA
FAQ_URLstringFAQ link. The value is fixed: https://cleeng.zendesk.com/hc/en-us
IS_RTLbooleanText direction: left to right locale (0), right to left locale (1)

Specific template parameters

This section is divided into email templates.

It contains specific template parameters that are applicable to particular email templates and are used besides global ones.

📘

Important

It's crucial to note that the Specific Template Parameters are unique to each designated template. These parameters cannot be interchanged or utilized across different templates. Each event and its associated payload are designed for a single email template. Attempting to incorporate a payload element, such as a renewal date, into a template not intended for it won't be feasible.

Welcome email

No specific parameters for "Welcome email" template.

Access purchased

Specific Template ParameterTypeDescription
OFFER_AMOUNTnumberOffer amount
OFFER_CURRENCYstringOffer currency
OFFER_TYPEstringOffer type
OFFER_NAMEstringOffer name
RENEWAL_DATEstringRenewal date
TRIAL_STATUSbooleanTrial status (whether a subscription is or is not in a trial period)

Invoice

Specific Template ParameterTypeDescription
TRANSACTION_NAMEstringTransaction name
TRANSACTION_PRICE_TAXnumberTransaction amount - with tax included
TRANSACTION_PRICE_NO_TAXnumberTransaction amount - with tax excluded
TRANSACTION_CURRENCYstringTransaction currency
TRANSACTION_TAX_RATEnumberTax rate (%) used in the transaction
TRANSACTION_DATEstringDate of payment
TRANSACTION_IDstringTransaction ID
TRANSACTION_TAX_VALUEnumberTransaction tax value
FEE_NAMEstringName of the fee charged for the transaction, e.g handling fee
FEE_VALUEnumberFee amount
FAQ_URLstringFAQ link
CUSTOMER_COUNTRYstring2-letter customer country code (ISO 3166 country code)
OFFER_NAMEstringOffer name
TRIAL_STATUSbooleanTrial status (whether a subscription is or is not in a trial period)

Renewal announcement

Specific Template ParameterTypeDescription
OFFER_AMOUNTnumberOffer amount
OFFER_CURRENCYstringOffer currency
RENEWAL_DATEstringRenewal date

Subscription renewed

Specific Template ParameterTypeDescription
IS_SUB_REACTIVATEDbooleanWhether a subscription is reactivated

Access expired

Specific Template ParameterTypeDescription
TRIAL_STATUSbooleanTrial status (whether a subscription is or is not in a trial period)

Failed payment

Specific Template ParameterTypeDescription
REJECTED_COUNTnumberCount of the rejected payment attempts
PAYMENT_METHODstringPayment method
OFFER_AMOUNTnumberOffer amount
OFFER_CURRENCYstringOffer currency
FAILURE_REASONstringFailure reason

Forgot password

Specific Template ParameterTypeDescription
RESET_PASSWORD_URLstringPassword reset link

Credit card issues

Specific Template ParameterTypeDescription
CARD_EXPIREDbooleanStatus of a customer’s card

Refund confirmation

Specific Template ParameterTypeDescription
OFFER_NAMEstringOffer name
REFUND_AMOUNTnumberRefund amount

Gift subscription

Specific Template ParameterTypeDescription
PERSONAL_NOTEstringPersonal note from a gifter (the person buying a gift) to a gift recipient, attached to a gift
IS_PERSONAL_NOTE_ATTACHEDbooleanWhether a personal note is attached or not
GIFT_CODE_URLstringLink to gift code verification and redemption
OFFER_NAMEstringOffer name

Subscription switched

“Subscription switched” template can differ depending on the algorithm variable. (For more information on algorithms, see Supported subscription switch algorithms).

Specific Template ParameterTypeDescription
OFFER_NAMEstringOffer name
OFFER_AMOUNTnumberOffer amount
IS_DEFERREDbooleanWhether DEFFERED algorithm was used
IS_IMMEDIATE_AND_CHARGE_WITHOUT_PRORATIONbooleanWhether IMMEDIATE_AND_CHARGE_WITHOUT_PRORATION algorithm was used
IS_IMMEDIATE_AND_CHARGE_WITH_FULL_REFUNDbooleanWhether IMMEDIATE_AND_CHARGE_WITH_FULL_REFUND algorithm was used
IS_IMMEDIATE_AND_CHARGE_WITH_REFUNDbooleanWhether IMMEDIATE_AND_CHARGE_WITH_REFUND algorithm was used
IS_IMMEDIATE_AND_CHARGE_WITH_TIME_PRORATIONbooleanWhether IMMEDIATE_AND_CHARGE_WITH_TIME_PRORATION algorithm was used
IS_IMMEDIATE_WITHOUT_PRORATIONbooleanWhether IMMEDIATE_WITHOUT_PRORATION algorithm was used
IS_IMMEDIATE_WITH_TIME_PRORATIONbooleanWhether IMMEDIATE_WITH_TIME_PRORATION algorithm was used

Subscription stopped

No specific parameters for "Subscription stopped" template.