Email Template Variables

This article elaborates on the email template variables and explains them

Various email events on nector

Some of the common emails fired from nector

• When customer is created or updated - lead_create and lead_update
  
• When coupon is created or updated - coupon_create and coupon_update
  
• When order is created or updated - order_create and order_update
  
• When wallet transaction is created or updated - walletreward_create and wallettrasaction_update
  
• When review is created or updated - review_create and review_update

• When customer's VIP tier changes - viptier_create
  
  A few other emails fired from nector

• When review request is being sent after the order is placed - reviewrequest_create
  
• When incomplete referral nudge is being sent to the referee - incompletereferralrequest_create
  
• When unused coupon nudge is being sent - unusedcouponrequest_create
  
• When unused coin nudge is being sent - unusedwalletcoinrequest_create
  
• When coin expiry nudge is being sent - coinexpirynotify_create
  
• When notify nudge is being sent to referee by referer - refereenotify_create

• When notify nudge is being sent to the referrer after successful referral - referrernotify_create
  

Common email variables sent on every email event

business_name: "name of the business (string)",
business_uri: "website url of the business (string)",
nector_business_uri: "website url of the business (string)",
business_coin_name: "coin name (string)",
business_currency_code: "currency code (string)",
business_currency_symbol: "currency symbol (string)",
user_customer_id: "user's customer id on host platform (string)",
user_name: "user's name (string)",
user_email: "user's email (string)",
user_mobile: "user's mobile (string)",
user_tier: "user's tier (string)",
user_type: "user's type (string)",
user_referral_code: "referral code of the user (string)",
user_referred_by_referral_code: "referral code of the customer who referred this customer (string)",
user_referral_link: "referral link of the customer (string)",
user_new_referral_link: "referral link of the customer (string)",
user_available_balance: "coin balance of the user (number)",
user_balance: "coin balance of the user (number)",
user_dob: "dob of the user in DD-MM format (string)",
user_full_dob: "dob of the user in DD-MM-YYYY format (string)",
user_country: "user's country (string)",
user_transaction_amount: "total order amount (number)"

Extra email variables specific to lead_create, lead_update

There are no extra properties for these 2 email events

Extra email variables specific to coupon_create, coupon_update, and unusedcouponrequest_create

coupon_name:'1% Off',
coupon_description: '',
coupon_value: 'TENOFF',
coupon_new_fiat_value: 10,
coupon_fiat_target: 'cart',
coupon_fiat_class: 'amount',
coupon_minimumcart_amount: 0,
coupon_expire: '2023-05-18T06:40:34.898Z',
coupon_formatted_expire: 'June 2nd 2023, 6:40:33 am',
coupon_redirect_link: 'https://nector-dev-store-99.myshopify.com/discount/TWOOFFVERYGOOD?utm_source=nector&utm_medium=email&utm_campaign=transactional',
coupon_created_at: '2023-05-18T06:40:34.898Z'

Extra email variables specific to walletreward_create, wallettrasaction_update, and unusedwalletcoinrequest_create

wallettransaction_title: 'Test',
wallettransaction_description:'',
wallettransaction_amount: 10,
wallettransaction_closing_balance: 10,
wallettransaction_consolidated_cr: 100,
wallettransaction_consolidated_dr: 90,
wallettransaction_type: 'reward',
wallettransaction_status: 'success',
wallettransaction_created_at: '2023-05-18T06:40:34.898Z'

Extra email variables specific to review_create, review_update

review_name: 'Ayush',
review_title: 'Very Good',
review_rating: 4,
review_description: 'I Like the Product',
review_created_at: '2023-05-18T06:40:34.898Z'

Extra email variables specific to order_create, order_update

order_name: '#1028',
order_date: '2023-05-18T06:40:34.898Z',
order_amount: 100,
order_discount: 0,
order_redirect_link: 'https://nector-dev-store-1.myshopify.com/74023928101/orders/6792fa1820a88c90c85fc12339ec7be0/authenticate?key=100a341ee60cf741d98714cca1e245ea&utm_source=nector&utm_medium=email&utm_campaign=transactional',
order_currency_code: 'usd',
order_currency_symbol: '$',
order_status: 'pending',
order_financial_status: 'pending',
order_delivery_status: 'pending',
order_created_at: '2023-05-18T06:40:34.898Z'

Extra email variables specific to reviewrequest_create

order_name: '#1028',
order_date: '2023-05-18T06:40:34.898Z',
order_amount: 100,
order_discount: 0,
order_redirect_link: 'https://nector-dev-store-1.myshopify.com/74023928101/orders/6792fa1820a88c90c85fc12339ec7be0/authenticate?key=100a341ee60cf741d98714cca1e245ea&utm_source=nector&utm_medium=email&utm_campaign=transactional',
order_review_link: "https://reviewcollect.nector.io?order_id=dbd690280a6",
order_currency_code: 'usd',
order_currency_symbol: ',
order_status: 'pending',
order_financial_status: 'pending',
order_delivery_status: 'pending',
order_created_at: '2023-05-18T06:40:34.898Z'

Extra email variables specific to refereenotify_create, referrernotify_create, incompletereferralrequest_create

referral_mode: "link",
referred_by_name: "Yashas",
referred_to_name: "yashas reddy",
referral_referred_by_name: "Yashas",
referral_referred_to_name: "yashas reddy",
referral_status: "completed",
referral_created_at: "January 24th 2024, 1:27:50 pm",

// if the referrer reward is wallet coins, below properties will be present
wallettransaction_title: "Referral Reward",
wallettransaction_description: "",
wallettransaction_amount: 200,
wallettransaction_closing_balance: 400,
wallettransaction_consolidated_cr: 1000,
wallettransaction_consolidated_dr: 100,
wallettransaction_operation: "cr",
wallettransaction_type: "reward",
wallettransaction_status: "success",
wallettransaction_created_at: "January 10th 2024, 1:27:50 pm",

// if the referrer reward is a coupon, below properties will be present
coupon_name: "₹200 Off coupon",
coupon_description: "No minimum cart amount required",
coupon_value: "necpri8a5hzqlomidas",
coupon_code: "necpri8a5hzqlomidas",
coupon_new_fiat_value: 200,
coupon_fiat_value: "200 Off",
coupon_fiat_target: "cart",
coupon_fiat_class: "amount",
coupon_minimumcart_amount: 199,
coupon_expire: "2024-01-09T13:27:50.896Z",
coupon_formatted_expire: "January 24th 2024, 1:27:50 pm",
coupon_redirect_link: "https://nector-dev-store-2.myshopify.com/discount/necpri8a5hzqlomidas?utm_source=nector&utm_medium=event&utm_campaign=transactional",
coupon_created_at: "January 10th 2024, 1:27:50 pm"

Extra email variables specific to coinexpirynotify_create

wallet_expiry_unit: "month", // values: month, week, day
wallet_expiry_amount: 500,
wallet_expiry_notify_generated_on: "2023-04-26T11:23:07.692Z",
wallet_expiry_estimated_on: "2023-04-26T11:23:07.692Z",
wallet_expiry_formatted_estimated_on: "June 2nd 2023, 6:40:33 am"

Extra email variables specific to viptier_create

viptier_tier: "silver",
viptier_direction: "up",
viptier_formatted_tier: "Silver",
viptier_created_at: "June 2nd 2023, 6:40:33 am"

Updated on: 12/09/2024