Skip to main content
All CollectionsEmail APIOthers
Mailtarget Substitution Data
Mailtarget Substitution Data
P
Written by Product Support
Updated this week

This document outlines the conventions and limitations for naming Substitution Data when sending emails in Mailtarget. Adhering to these guidelines ensures seamless integration and performance of the system.

Substitution Data Limitations

  1. Allowed Characters:

    • Substitution Data names may only include letters (a-z), numbers (0-9), and underscores (_).

  2. Start with a Letter:

    • All Substitution Data names must begin with a letter. Starting a name with a number or special character is not allowed.

  3. Reserved Keywords:

    • Certain keywords are reserved and cannot be used as Substitution Data names because they are system-defined. The reserved keywords are:

      • address

      • email

      • email_id

      • env_from

      • return_path

      • Programming keywords: and, break, do, else, elseif, end, false, for, function, if, local, nil, not, or, each, return, then, true, until, while

  4. Handling Non-Compliant Data:

    • If there is Substitution Data that does not comply with the rules outlined above, it must be deleted. Subsequently, you need to re-import the data with a new name that adheres to these guidelines.

Examples

  • Valid Field Names:

    • user_name

    • contact1

    • customer_id

  • Invalid Field Names:

    • 1st_contact (starts with a number)

    • email (reserved keyword)

    • @username (contains special character @)

Best Practices

  • Choose descriptive yet concise names for Substitution Data to ensure clarity.

  • Regularly review Substitution Data names for compliance, especially when system updates or new data is added.

  • Consider creating a naming convention strategy document that outlines prefixes or suffixes for specific types of data to maintain consistency.

By following these conventions, you can prevent errors during email sending operations and ensure compatibility with the Mailtarget system. This facilitates smoother integration and minimizes potential disruptions caused by naming conflicts or system-defined keyword usage.

Did this answer your question?