Using macros, you can personalize automatic emails or manual emails to include specific information about the recipient, such as first name or organization name. A macro is a special code that gets replaced with information specific to each recipient. For example, the {Contact_First_Name} macro will be replaced with each recipient's first name.
You cannot edit or otherwise modify macros. You can only insert or remove them.
Inserting a macro
Macros can be inserted in manual emails or email templates. Inserting macros in email templates ensures that all recipients receive a standard yet customized message.
To insert a macro in an email or email template, follow these steps:
- Beginning composing the email or editing the email template.
- Click within the email or email template where you want the macro to appear.
- Click the Macro icon on the content editor toolbar.
- From the list that appears, select the macro(s) you want to use. Only the macros specific to this type of email (e.g. invoice email) will be available.
The sample data that is displayed beside each macro is drawn from the first contact in your mailing list (in the case of manual emails) or from your own contact record (in the case of email templates). - Click the Insert macro button.
Instead of inserting a macro, you can insert text then link that text to a macro. When linking the text, enter the macro name within curly brackets – e.g. {Unsubscribe_Url} – in the Website URL or email field.
Each email or email template can contain any number of macros, both within the subject line and the body of the message.
For a complete description of the available macros, see System macros and Custom field macros (below).
You should add a link to the {Unsubscribe_Url} macro so recipients can easily unsubscribe from your mailing list. If a link to the {Unsubscribe_Url} macro does not appear in your email, one will be automatically appended to the message. For more information on providing an unsubscribe link, click here.
Behavior of macros in preview and in test emails
When you preview a manual email, any macros within the message will be replaced by sample data that is drawn from the contact record for the first recipient in your mailing list. When you send a test email, the sample data is drawn from your own contact record, not the first contact in the recipient list.
When you customize automatic emails, such as membership notifications, event emails, invoices, and receipts, the contact-specific data for the test email will be drawn from your own contact record. Macros that are not contact-specific will be replaced in test emails with random or fake data. For example, invoice/receipt test emails will use random or fake data for the invoice number, item description, and amount.
Macros by email type
Different kinds of macros are available to be inserted depending on the kind of email or email template you are modifying. For example, event macros are only available when modifying event emails, and cannot be inserted into manual emails. If you manually enter a macro that is not supported for the type of email or email template you are modifying, it will be ignored.
The table below lists the kinds of macros that are available for each email type:
Manual emails
- Organization, Contact, Member, Bundle
Membership emails/receipts
- Organization, Contact, Member, Bundle
Event announcements
- Organization, Contact, Member, Event info
Event reminders/confirmations
- Organization, Contact, Member, Event info, Event registration
Invoices
- Organization, Contact, Member, Bundle, Invoice, Receipt
Payment receipts
- Organization, Contact, Member, Bundle Receipt
Donation emails/receipts
- Organization, Contact, Member, Donation
Online store emails
- Organization, Contacts, Members, Finances, Online store
System macros
The following macros are provided by Wild Apricot. You can also insert custom field macros (see below) that display data from custom fields you have added to your database.
These macros are case-sensitive.
Organization macros
Organization_Name
Your organization name
Organization_Contact_Email
Contact email for your organization
Organization_URL
URL of your organization
Payment_Instructions
Payment instructions for membership applications and manual invoices
Organization_Payment_Instructions
Payment instructions for membership renewals
Contact macros
User_ID
Unique identifier assigned to contact
Contact_First_Name
First name from contact record
Contact_Last_Name
Last name from contact record
Contact_FullName
First and last name from contact record
Contact_Organization
Organization from contact record
Contact_Email
Email from contact record
Contact_BalanceAmount
Current balance for contact
Contact_Password_Reset_URL
Link to reset password page
Unsubscribe_Url
Link to unsubscribe page
Member macros
Member_Level_Fee
Level fee
Member_Level
Name of membership level
Member_Subsequent_Renewal_Date
Member's next renewal due after the upcoming renewal
Member_Profile_URL
Link to member profile page
Member_Public_Profile_Url
Link to public member profile
Member_Upcoming_Renewal_Date
Member's next renewal date (using the account date format)
Member_Since
Member since date
Member_Status
Status of member
MemberField_Group_participation
Member groups that member belongs to
Member_Level_Full
Combines the following macros: Member_Level ( Member_Level_Fee )
Bundle macros
Bundle_Administrator_Name
Name of the bundle administrator
Bundle_Administrator_Email
The bundle administrator's email address
Bundle_Administrator_CountOfMembers
Number of active bundle members (does not include bundle administrator, or archived members)
List_of_Bundle_members
Names of the bundle members, including archived members
Event information macros
Event_Title
The event name.
Event_Date
The event's start date.
Event_EndDate
The event's end date.
Event_TimeZone
The selected time zone.
Event_Time
The start time of the event.
Event_EndTime
The end time of the event.
Event_UpcomingSessionDate
The start date of the next upcoming session.
Event_UpcomingSessionTime
The start time of the next upcoming session.
Event_UpcomingSessionEndDate
The end date of the next upcoming session.
Event_UpcomingSessionEndTime
The end time of the next upcoming session.
Event_SessionsList
A list of all sessions (including past ones)
Event_Location
The location of the event.
Event_Details
Description field within event details.
Text styles and other theme-dependent formatting in the event description will be lost when inserted into an email using this macro.
Days_till_Event
The number of days until the event begins.
Event_Url
The Internet address of the event details page for this event.
Event_Payment_Instructions
The payment instructions entered on the Registration types & settings tab. This macro can only be used for event registration pending emails.
Registration_buttons
Inserts Register and Not attending buttons, allowing the invitees to register for the event or indicate that they do not plan on attending. This macro is only available for event announcements. For more information, see Providing a Not attending option.
Event registration macros
Registration_First_Name
First name from event registration
Registration_Last_Name
Last name from event registration
Registration_Email
Email name from event registration
Registration_Price
Registration type price + extra costs + Registration_Guest_Total_Price
Registration_Guest_Count
Number of guests
Registration_Guest_Names
Displays the first and last names of all registered guests.
Registration_Guest_Total_Price
Guest registration price + extra costs
Registration_Type
Name of registration type
QR_Code
The QR code containing registration information to scan for check in.
Donation macros
Donation_Number
Number of donation
Donation_Date
Date
Donation_Amount
Amount
Donation_Tender
Tender
Donation_Comments
Comments from donor
Donation_PublicMemo
Comments for payer field
Invoice macros
Invoice_Number
Invoice number
Invoice_Date
The date of the invoice.
Charge_Amount
The total amount of the invoice.
Amount_Owing
The amount owing on the invoice.
Amount_Paid
The amount paid towards the invoice.
Invoice_Status
The current status of the invoice.
Invoice_Origin
The type of transaction.
Invoice_PublicMemo
Comments for payer field
Invoice_Details_URL
Link to invoice details in public profile which allows the recipient to view and pay the invoice online (does not require logging in)
Invoice_Details
Displays the invoice items
Payment receipt macros
Payment_Date
The date of the payment.
Payment_Amount
The amount of the payment
Payment_SettledAmount
The portion of the payment that has been settled.
Payment_Tender
The method by which the payment was received.
Payment_AvailableBalance
The unsettled portion of the payment.
Payment_PublicMemo
Comments for payer field
Payment_SettlementsTable
Combines the following macros: Invoice_Date, Invoice_Number, Invoice_Origin
Online store
Order successfully created
Sent to the customer and organization contact once the customer finishing checking out.
Order shipped / fulfilled
Sent to the customer and organization contact when the status of the order is set to fulfilled.
Order canceled
Sent to the customer and organization contact when the order is canceled.
New order
Sent to the organization contact once the customer completes checkout.
Custom field macros
You can use macros to display information stored in the custom fields you have added to your Wild Apricot database.
Custom field macros use the following format:
{fieldtypeField_fieldname}where fieldname is the name of the field, spaces are converted to underscores, and fieldtype is one of the following:
-
Contact
Example: {ContactField_Phone} -
Member
Example: {MemberField_JobTitle} -
Event
Example: {EventField_Preferred_Seating} -
Donation
Example: {DonationField_Fund}
The information displayed by each custom macro depends on the custom field type.
In addition to the individual custom field macros, a macro that combines information from all the custom fields of a particular field type is also available. This macro uses the following format:
{fieldtypeField_All}For example:
{ContactField_All}Do not insert a macro for a field whose access is set to No access. If you do, the resulting value will be blank.
