LogoLogo
Release notesHomepageTry demo
  • Welcome to the B2COPY knowledge base
  • Admin guide
    • Sign-in and 2FA
    • General interface overview
    • Configure B2COPY
      • Configure copy-trading and MAM settings
      • Configure PAMM settings
      • Configure Web UI settings
        • Show on Leaderboard
        • Show on Statistics page
        • Show on Trading Report
        • Fee settings
        • Subscription settings
        • Risk Ratio settings (applicable for copy trading only)
        • Account Properties
      • Configure account settings
        • Account settings
        • Default Master’s Positions Visibility
        • Default Investor’s Positions Visibility (applicable for PAMM only)
      • Configure access settings (only for a standalone solution)
      • Configure deposit and withdrawal settings (only for a standalone solution)
      • Configure the performance fee calculation settings
      • Configure the management fee calculation settings
      • Configure symbol mapping
      • Configure the trade fee filter
      • Configure B2COPY widgets
      • Prevent syncing of collapsed MetaTrader trading history with B2COPY
      • Copy positions to investment accounts with master account prices
      • Link open positions
      • Enable clients to select account groups when creating master and investment accounts in the Web UI
      • Run the Introducing Brokers (IB) program
        • Manage IB levels
        • Customize the IB partnership settings of investment accounts
      • Allocate custom rewards for assistance in managing master accounts
      • Use email templates to notify clients about important events
    • Register new Back Office users
      • Disable 2FA for Back Office users
    • Register new clients
      • Register new clients with email addresses
      • Register new clients with MT account logins (only for a standalone solution)
      • Add a profile picture and nickname to a client profile
    • Manage master and investment accounts
      • Create a master account
      • Set the default allocation parameters for a copy-trading or MAM master account
      • Set the allocation method and rollover settings for a PAMM master account
      • Create fee plans for a master account
      • Modify the default fee plan for a master account
      • Assign risk limits to a master account
      • Determine if risk limits are assigned to a master account
      • Assign a minimum deposit to a master account
      • Assign a subscription code to a master account
      • Set up a promo offer for a master account
      • View and execute pending PAMM requests on master accounts
      • Cancel pending PAMM requests on investment accounts
      • Create an investment account
      • Archive master and investment accounts
      • View information about archived accounts
      • Restore archived accounts
    • Manage trading robots
    • Manage subscriptions
      • Create a copy-trading or MAM subscription
      • Create a PAMM subscription
      • Assign a risk limit to a subscription
      • Modify a subscription
      • Resync open positions on a master account with subscribed investment accounts
      • Change a fee plan for an existing subscription
      • Initialize instant fee payments for subscriptions
      • View details about fees paid for a subscription
      • Pause and resume subscriptions
      • Terminate or reactivate a subscription
    • Manage deposits and withdrawals
      • Deposit funds to copy-trading and MAM accounts
      • Withdraw funds from copy-trading and MAM accounts
      • Deposit funds to PAMM accounts
      • Withdraw funds from PAMM accounts
  • User guide
    • Sign-in and 2FA
    • Account details
      • Subscriptions page
      • Trading Report page
      • Statistics page
      • Settings page
      • Requests page (for PAMM accounts only)
      • Fee Payments page
    • Use the Leaderboard to find the best-performing master accounts
    • Manage master and investment accounts
      • Create a master account
      • Set up or modify a fee plan for your master account
      • Change your master account visibility on the Leaderboard
      • Assign a subscription code to your master account
      • Assign a minimum deposit to your master account
      • Set up a promo offer for your master account
      • View and update rollover settings of your PAMM master account
      • Create an investment account
      • Add your profile picture and nickname
      • Add or change your account name
      • Reset your account password
    • Manage subscriptions
      • Create a subscription
      • Create a subscription using a subscription code
      • Create a subscription using a promo code
      • Change a risk ratio and allocation method for a subscription
      • Assign a risk limit to a subscription
      • Enable or disable the reverse copy option for a subscription
      • Check a fee plan applied to a subscription
      • Detach open positions copied into investment accounts
      • Pause or resume a subscription
      • Terminate and reactivate a subscription
    • Manage deposits and withdrawals
      • Deposit funds to your copy-trading and MAM accounts
      • Withdraw funds from your copy-trading and MAM accounts
      • Deposit funds to your PAMM accounts
      • Withdraw funds from your PAMM accounts
  • Copy-trading, PAMM, and MAM concepts
    • General comparison of copy-trading PAMM and MAM accounts
    • Allocation methods for copy trading and MAM
    • Allocation methods for PAMM
      • Reallocation on deposit and withdrawal
      • No action on deposit and autocorrection on withdrawal
    • Fee list
    • Return calculation
    • Drawdown and Maximum drawdown calculation
    • Risk limits for investors
    • Risk limits for master traders
    • Score calculation
  • API Documentation
    • Authorization in the Back Office
    • Get a list of master and investment accounts
    • Create a master or investment account using the existing MT account
    • Get data for the Statistics widget
    • Get data for the Leaderboard widget
    • Seamless authorization (only for a standalone solution)
    • Register a client and create their payment account (only for a standalone solution)
  • Video tutorials
  • Key terms
  • Release notes
Powered by GitBook
On this page
  • Manage email templates
  • Set key-value pairs
  • View a list of sent email notifications

Was this helpful?

  1. Admin guide
  2. Configure B2COPY

Use email templates to notify clients about important events

Learn how to manage email templates for client notifications in the Back Office, customize content, enable/disable templates, and track email delivery statuses

In the Back Office, you can manage predefined email templates that are used to notify clients about important events, such as creating new master and investment accounts or subscribing and unsubscribing to/from master accounts.

To view a full list of predefined email templates, go to System > Templates > Email > Templates.

The following is a list of email templates used for email notifications specific to the B2COPY investment platform:

Template type name
Description

New copy-trading accounts

InvestmentMasterAccountCreated

Used to notify a client about a newly created copy-trading master account and provide the account details

InvestmentInvestorAccountCreated

Used to notify a client about a newly created copy-trading investment account and provide the account details

New MAM accounts

MamMasterAccountCreated

Used to notify a client about a newly created MAM master account and provide the account details

MamInvestorAccountCreated

Used to notify a client about a newly created MAM investment account and provide the account details

New PAMM accounts

PammMasterAccountCreated

Used to notify a client about a newly created PAMM master account and provide the account details

PammInvestorAccountCreated

Used to notify a client about a newly created PAMM investment account

New subscriptions (used for all copy-trading, MAM, and PAMM subscriptions)

InvestmentNewSubscriber

Used to notify a master account owner about a new subscription to their master account and provide subscription details

InvestmentNewSubscription

Used to notify an investor about their new subscription to a master account and provide subscription details

InvestmentCloseSubscription

Used to notify an investor about their unsubscription from a master account

Other

accountPassword

Manage email templates

You can disable or enable email templates, change the subjects of email notifications, and edit the HTML and Twig code that forms the email body.

Making substantial changes to predefined email templates requires a good understanding of HTML and Twig. If you're not familiar with these instruments, it's recommended to make only minor edits, such as changing the text color or company name.

Modify a selected email template as follows:

On the Email template page, click the Edit button located in the template row.The Edit email template page opens.

To disable the email template, select No in the Enabled dropdown. If the template is disabled, notifications about the related event aren’t sent to clients.

To enable the email template, select Yes in the Enabled dropdown.

To change the email subject, update the text displayed in the Subject field. The email subject typically includes your company name followed by the specific subject of the email notification.

{{ keyvalue('mail_subject_company') }} | Master Account Created

The company name is stored in a key-value pair. In this case, the key “mail_subject_company” is assigned a string containing your company name. During email rendering, the key is replaced with your company name. For a list of key-value pairs supported for email templates and details on how to assign values to keys refer to Set key-value pairs below.

In the Email Template field, you can view the email body coded in HTML and Twig. The Preview field displays how the code will be rendered in emails.

The preview may not show all possible template variants because a template may include variables that are substituted with actual values during email rendering. For example, the following Twig code substitutes a client's name into an email notification:

{% if entity.info.givenName != "" %}
    Dear {{ entity.info.givenName }},

{% else %}
    Dear client!

{% endif %}

If the name is specified in a client profile, it is substituted into the email notification; otherwise, “Dear client!” is used instead of the client’s name.

In addition to substitutional variables, the email body may contain keys that are replaced with values that are stored in the key-value storage (for details, refer to Set key-value pairs below).

Click Save to apply the changes made to the email template.

Set key-value pairs

Email templates for client notifications contain keys that are replaced with the values assigned to them. These key-value pairs are stored in the key-value storage. You can modify the values assigned to keys as follows:

1

Go to System > Key storage > Key storage values.

The following are some keys commonly used in email notifications. You can change the values assigned to these keys.

  • mail_subject_company – the name of your company displayed in the subjects of email notifications

  • mail_company_name – the name of your company displayed in the text of email notifications

  • mail_support_email – the email address of the Support team in the text of email notifications

  • mail_logo_url – the URL of an image that is included as a company logo in email notifications

  • mail_logo_height – the logo height, in pixels

  • mail_logo_width – the logo width, in pixels

  • mail_text_color – the text color used in email notifications

  • mail_content_bg – the background color applied to content blocks in email notifications

  • ‍mail_body_bg – the background color applied to email notifications

2

Select a key and click the Edit button located in the key row.

3

In the Value field, enter a new value that you want to assign to the selected key.

4

Click Save to apply the changes.

View a list of sent email notifications

To view a list of email notifications sent to your clients, go to Mailing > System > Log.

On the Mailing Log page, you can view a list of email notifications sent to clients and view the following information:

ID ‍The email identifier in the system.

Active queue ID ‍The identifier of the queue in which the email is included.

Email ‍The client email address.

Subject ‍The email subject.

Attempt date ‍The date and time of the last attempt to send the email.

Status ‍The email delivery status:

  • IN PROGRESS

  • FAIL

  • SUCCESS

Reason ‍The reason why the email delivery failed.

PreviousAllocate custom rewards for assistance in managing master accountsNextRegister new Back Office users

Last updated 6 days ago

Was this helpful?

Sent to a client after the client clicks the Reset password button on the in the Web UI in order to change the password for their trading account, and then selects the Random method setup. In this case, the email notification includes a newly generated password.

Settings page
Edit email template
Set a key-value pair
Edit email template
Set a key-value pair
The log of sent email notifications