Email Templates – Complete Knowledge Base Guide
This document provides a complete overview of email templates, including how they work, how they can be edited, available variables, trigger context, and system limitations.
1. How to Update Email Templates
At the start of our collaboration, we provide a set of default email templates.
From the CRM, it is possible to edit the style, layout, branding, colors, and formatting of these emails to match your company’s needs.
However, please DO NOT:
• Edit the placeholders inside double brackets (e.g., {{name}}, {{accountDetails.login}}, etc.). These are dynamic fields automatically populated with user-specific data.
• Create new email templates.
Full tutorial on Email Templates:https://www.loom.com/share/436d6b3f15274a858b8500e2ef23d1ec?sid=d39c66b8-9a63-4b5e-88d7-91ff9b335c1aPassword: Email$techTTS
2. Variables in Email Templates
Each email template includes its own unique set of variables specific to that template.
There is no universal master list of variables. Only variables included in a given template can be used within that template.
Variables appear inside double brackets {{ }}.
• Common login-related placeholders include:
• Login → {{accountDetails.login}}
• Password → {{accountDetails.password}}
• Investor Password → {{accountDetails.passwordInvestor}}
• Server → {{account.metaServer}}
• Platform → {{account.platform}}
3. Global / Branding Variables
Variable | Description |
${company_name} | Company/whitelabel name |
${logo_url} | Header logo image URL |
${footer_image_url} | Footer image URL |
${primary_color} | Brand primary color |
${support_email} | Support email address |
${website_url} | Main website URL |
${discord_url} | Discord social link |
${instagram_url} | Instagram social link |
${youtube_url} | YouTube social link |
${twitter_url} | Twitter/X social link |
4. Email Template Trigger Overview
Below is a structured overview of system email templates and when they are triggered.
Template Name | Trigger Context | Key Variables |
WELCOME | User registers on the platform | {{name}}, {{password}}, {{user_email}}, {{url}} |
PENDING_KYC | User initiates KYC verification | {{name}} |
KYC_VERIFICATION_COMPLETED | KYC successfully completed | {{name}}, {{dashboard_url}} |
LOGIN_DETAILS_PHASE1 | Phase 1 account created | {{accountDetails.*}}, {{account.*}} |
PASS_PHASE1_REVIEW | Phase 1 review passed | {{name}} |
PASSED_EVALUATION | Trader completes full evaluation | {{name}} |
DRAWDOWN | Account fails due to drawdown breach | {{name}}, {{coupon}}, {{custom_notes}} |
RULE_VIOLATION | Trading rule violation detected | {{name}}, {{reason}} |
FAILED_REVIEW | Admin manually fails account | {{name}}, {{reason}} |
WITHDRAWAL_APPROVED | Withdrawal request approved | {{name}}, {{withdrawal.amount}} |
COMPETITION_SIGNUP | User completes competition signup | {{name}}, {{competition_name}} |
AFFILIATE_NEW_COMMISSION | Affiliate earns commission | {{name}}, {{commission_amount}} |
REWARD_TASK_APPROVED | Reward task approved | {{name}}, {{task_title}}, {{points}} |
5. Not Used / Legacy Templates
Some templates are defined in the system but may not currently be actively triggered in the codebase. These may be reserved for future use or considered legacy.
• Examples include:
• PENDING_KYC
• KYC_VERIFICATION_REJECTED
• COMPETITION_WINNER
6. Multi-Language Support
Currently, the system does not support multiple languages within email templates.
7. Blocking & Failing Accounts – Email Behavior
An email is automatically sent when an account fails during the verification phase. The trader will receive the 'Failed Review Reason' within the email.
If an account is manually blocked, there is no automatic email sent.
Recommended flow: wait for the verification phase and fail the account to trigger the appropriate system notification.