Email/SMS Replacement Codes =========================== .. caution:: Please note a few points before you begin using these codes #. They are **case-sensitive**. Unless otherwise indicated, they are all lower-case. #. They are for **specific uses**, so pay attention to the main headers below, as those indicate where/how you can use them. For example: You cannot insert ``{paylink}`` in a regular email to an individual and have it function correctly. It works only from an Involvement or in an online registration confirmation email. #. They should **never be made bold or italics or underlined** as that will insert HTML characters that will affect the replacement code. Basically, do not add any type of formatting to an email replacement code. .. note:: You can copy a specific paylink (right-click, copy) from the individual's Member Dialog for an Involvement and email a paylink that way. All Emails ---------- These replacements can be used in any email sent via TouchPoint. There are category headings within this section to make it easier to find the codes. Email Related Replacements ~~~~~~~~~~~~~~~~~~~~~~~~~~ These are miscellaneous codes for tracking the email, unsubscribing, etc. ``{unsubscribe}`` Displays *Unsubscribe* as a link and will prevent future emails from that sender to that recipient ``{toemail}`` The email address of the recipient ``{fromemail}`` The email address of the sender ``{emailhref}`` The URL of the publicly viewable email. This only works if you checked the box to make the email public. This must be placed inside an anchor tag like so ``Your Text Link Here`` ``{track}`` Must have an image inserted in the body of the email. ``{tracklinks}`` This allows you to track how many times links in your email have been clicked. .. seealso:: :doc:`TrackingEmails` ``{today}`` Displays the current date in this format *m/d/yyyy* ``{cmshost}`` URL for your church's TouchPoint database ``{ChurchName}`` This will insert the church name that is in your database Settings. ``{ChurchAddress}`` This will insert the church address that is in your database Settings. ``{ChurchPhone}`` This will insert the phone number that is in your database Settings. If you do not have a phone number in the Settings, a message to that effect will display instead. Personal Information ~~~~~~~~~~~~~~~~~~~~ The following can be inserted into an email to verify someone's personal information, or can be used in confirmations, such as Donation Confirmation emails. ``{title}`` The recipient's title ``{name}`` First and Last Name of recipient ``{first}`` First Name of recipient or preferred name if there is one ``{last}`` Last Name of recipient ``{address}`` Line 1 of Street Address ``{address2}`` Line 2 of Street Address ``{city}`` Primary City ``{state}`` Primary State ``{csz}`` City, State Zip as a single replacement ``{homephone}`` Home Phone ``{occupation}`` Occupation ``{cellphone}`` Displays the cellphone number on a persons' record. Helpful if you are asking people to opt-in for texting. ``{receivesms}`` Recipient's current setting for receiving text messages - either **Yes** or **No**. .. seealso:: :doc:`TextingOptIn` ``{peopleid}`` Displays the person's PeopleId Number. ``{birthdate}`` Displays the person's full date of birth - month, day, year. ``{firstorjoint}`` How this works is dependent on the Contribution Type of the individuals. It will use the person's first name if the person has a Contribution Type of Individual. It will use the two Primary Adults' first names (John & Mary) if the couple each has a Contribution Type of Joint. If both spouses are included in the recipient list, they will each get the email addressed to both of them (John & Mary) if they give jointly. You can filter out one spouse by adding the Condition "Is Head of Household" = true, then the husband will receive the email addressed to both of them. If you add that Condition and you have couples that give individually the email will go only to the HOH and will be addressed only to him/her. Just think how you want to use this and create your searches accordingly. ``{altname}`` Alt Name of recipient .. seealso:: :doc:`../People/AltName` Contribution Statement Options ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ These replacements can be used in an email to individuals and are a good way to make sure you have a recipient's correct preferences regarding his contribution statements. ``{estatement}`` If Electronic Statement is not checked on their record, this will display: **Printed Statement in Addition to Online Option**. If it is checked, this will display: **Online Electronic Statement Only**. ``{statementtype}`` Displays **Individual**, **Joint**, or **None**, based on the selection on their record. ``{contributor.InformalName}`` Displays the contributor's Goes By name, if one exists, on the statement. If couple set for Joint Statement, will list name as John and Suzy Smith instead of Mr. and Mrs. John Smith. This would need to be updated in the `Admin > Advanced > Special Content > Text >StatementTemplate` file, replacing {{contributor.Name}} with {{contributor.InformalName}}. ``{contributor.InformalSalutation}`` If including a cover letter for the statement, this displays the contributor's Goes By name, if one exists, for the letter salutation. If couple set for Joint Statement, will list name as John and Suzy instead of John Smith and Suzy Smith. This would need to be updated in the `Admin > Advanced > Special Content > Text >StatementTemplate` file, replacing {{contributor.Name}} with {{contributor.InformalName}} in the letter body. Extra Values ~~~~~~~~~~~~ You can use the following to display extra values on an individual's record. You must know the type (code, text, date, int, bit) to display the information in the correct format. ``{extracode:field}`` Extra value with Code type ``{extratext:field}`` Extra value with Text type ``{extradate:field}`` Extra value with Date type ``{extraint:field}`` Extra value with Integer type ``{extrabit:field}`` Extra value with a bit type (checkboxes) ``{familyextracode:field}`` Family extra value with Code type ``{familyextratext:field}`` Family extra value with Text type ``{familyextradate:field}`` Family extra value with Date type ``{familyextraint:field}`` Family extra value with Integer type ``{familyextrabit:field}`` Family extra value with a bit type (checkboxes) ``{familyextratext:CoupleName}`` Family extra value called CoupleName ``{familyname}`` Family extra value called FamilyName. Each returns the ExtraValue named in the *field*. Replacements for Members of a Division ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The following ``{orgmember:...}`` replacements take a required *divid* parameter, where you enter a Division ID# where you see `divid`. The value returned in the email will be the specified value from the first Involvement in the specified division (divid) in which the person is a member. ``{orgmember:location,divid}`` Involvement Location---from the `Location` in the Involvement `Settings > General` tab ``{orgmember:pendingloc,divid}`` Involvement Pending Location---from the `Pending Location` in the Involvement `Settings > General` tab ``{orgmember:orgname,divid}`` Involvement Name ``{orgmember:leader,divid}`` Involvement Leader---the name of the first person enrolled in the Involvement having the *Member Type* matching the `Leader Type` specified for the Involvement .. admonition:: Example Using the `IsMemberOf` condition, run a search in Search Builder for everyone in the Program *Vacation Bible School* and Division *First Grade VBS* Notice the DivisionId # in the condition. It will be the 2nd number inside the parentheses `IsMember (125,6305,0) = True`. That is the number you use instead of divid in the replacement codes above. Drop Membership from an Involvement ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Drop From Involvement This is not in the normal form of an email replacement code, but it does function like one and can be used when emailing to an individual, a tag, Search Builder results or an Involvement. When the text below is inserted into any email, the link allows the recipient to drop himself from the Involvement indicated by the ID# in the code. Enter the actual **Involvement ID#** in place of the 242 you see below. 242 is the sample Involvement ID#. The recipient sees only the text that you see on line 2 below. You can edit it to say whatever you want. The code itself will not display the name of the Involvement, so you will either want to put that in the statement in place of 'this Involvement' or put another statement in the email so they understand which Involvement they will be dropped from. | ```` | ``Click here to be removed from this Involvement.`` | ```` .. important:: You cannot use another email replacement code inside the dropfromorg code. For example: Do NOT insert {org} in the statement 'Click here to be removed from this Involvement'. You cannot put any other replacement code in that text. .. _OrganizationContext: Involvement Context - Confirmations, Reminders, Normal Email ------------------------------------------------------------- These below all work when use in a Confirmation, a Reminder, or a regular email sent directly from an Involvement. :ref:`Click here for codes specific to a Scheduler involvement` :ref:`Click here for codes specific to a Ticketing involvement` ``{orgname}`` Name of Involvement ``{orgmembercount}`` Number of members in the Involvement ``{smallgroups}``, ``{smallgroups:[prefix]}`` This will display a list of all sub-groups that the person is assigned to. If you supply the optional ``:prefix`` designation, it will only list those groups that start with that prefix. ``{smallgroup:[prefix]}``, ``{smallgroup:[prefix],default}`` It will display the sub-group name person is assigned to which starts with the ``prefix``. If you use supply the ``default`` text, that is what will display if they are not assigned to any sub-group fitting that pattern. .. admonition:: Example This would be good for something like a sub-group to specify table number. For example you could have people assigned to tables with sub-groups that look like: ``table:1``, ``table:2`` etc. This way your email replacement code would be ``{smallgroup:[table:],you are not assigned a table}`` ``{addsmallgroup:name}`` This adds the recipient to the sub-group in the Involvement inserted in place of *name* in the replacement code. .. tip:: This is useful when emailing registrants over the period during which they are registering for an event. You may want to send them extra information after you have placed them at a table, or have approved their application or any other post registration process you may be doing. This way, you can track which persons you have been sent the email and only email those new registrants who are not already in the specified group. ``{tickets}`` Indicates the number of tickets purchased if you have that question in your registration. .. seealso:: :doc:`../OnlineRegistration/QuestionSettings` ``{barcode}`` Inserts barcode representing the registrant's PeopleId #. .. seealso:: :doc:`../Organizations/TicketingAttendance` ``{location}`` Room number (Location) that is on the Involvement's `Settings > General` tab ``{nextmeetingtime}`` The next future meeting the recipient is committed to attend. ``{nextmeetingtime0}`` The next future meeting that exists in an Involvement will display "none" if there is not a future meeting. ``{paylink}`` Displays this text: *Click this link to make a payment on your balance of $150.00* .. seealso:: :doc:`../OnlineRegistration/FeeSettings` .. important:: If you are manually sending an email that includes the {paylink} replacement code, you must use the `Individuals` or `Child with Parents CC'd` email options in order for it to generate properly. It will not work with the `Parents` email option since they are not the ones enrolled in the Involvement. .. note:: When you use the `Individuals` or `Child with Parents CC'd` options, the email will also be sent to the **Register Email**, if one exists. An Involvement member will have a **Register Email** if an email address was entered at the start of a registration and it differs from the email address stored on the registrant's record. ``{amount}`` Total amount of the fee ``{amtpaid}`` Total amount already paid ``{amtdue}`` Total amount due ``{orgextra:field}`` Returns the Involvement ExtraValue named *field* Confirmation Emails ------------------- These only work in a confirmation email. ``{details}`` Registration details such as checkboxes selected, answers to questions, etc ``{donation}`` The amount of extra donation, when `Ask Donation` is used with a regular online registration. ``{paid}`` Total paid for this registration .. seealso:: :doc:`../OnlineRegistration/MessagesSettings` .. note:: You can also use {details} in Reminder Emails for Volunteer Calendars, but not if the registration options changes. See :ref:`Organization Context ` above. .. seealso:: :doc:`../OnlineRegistration/MessagesSettingsReminder` New User Email -------------- ``{username}`` Username ``{password}`` Password Contribution-Related Email Templates ------------------------------------ We normally add to your database the necessary email templates related to One-Time Giving, Recurring Giving, and Online Pledges. These templates may be customized by going to `Admin > Communication > Email Templates` and filtering for the `GivingEmailTemplates` role. You can edit those if you want, using the following replacement codes. ``{church}`` Name of your church from `Admin > Advanced > Settings > System > Church Info > Church Name` ``{date}`` Date the donation was made ``{tranid}`` System-generated Transaction ID ``{amt}`` Amount of donation or dollar amount pledged ``{fund}`` Fund name ``{enddate}`` Date the recurring pledge is scheduled to conclude ``{giftsummary}`` Fund name and donation amount ``{recurringsummary}`` For newly created recurring gift schedules: fund name, frequency, amount, payment information. This is good for the Recurring Giving Setup template. ``{recurringsummaryall}`` For all recurring gift schedules: fund name, frequency, amount, payment information. This is good for the Recurring Giving Setup template. ``{contact}`` Name of the Email From person as designated on the Online Giving Setup page ``{contactemail}`` Email address of the Email From person as designated on the Online Giving Setup page ``{ChurchPhone}`` Phone number from `Admin > Advanced > Settings > System > Church Info` ``{fund[1,2,3],01/01/2022-12/31/2022}`` Show giving made to funds during a specific date range using the Fund ID. The `Finance` role is required to use this replacement code. - In the example above, what will display is the total given to Fund IDs 1, 2, and 3 in the calendar year of 2022 as ``9,750.00`` format. - If there is no giving to that fund in the defined period, it will show ``0.00``. - Any date range can be specified by adjusting the dates. The format of ``MM/DD/YYYY`` must be used to pull the proper dates. Recurring Gift Notice --------------------- We also have a template for the Recurring Gift Notice on your database. This may be customized by navigating to Administration > Setup > Special Content > Email Templates and filtering for the `SystemEmailTemplates` role. You can edit this if you want, using the following replacement codes. ``{giftsummary}`` For all recurring gift schedules: fund name and amount. You may also use many of the email replacement codes mentioned above, such as ``{first}``, ``{amt}``, ``{date}``, ``{church}``, ``{tranid}``, ``{name}``, ``{email}``, ``{homephone}``, and ``{cellphone}``. Pledge Replacements ~~~~~~~~~~~~~~~~~~~ These replacements can be put in an email to anyone in your database to indicate the amount of a pledge to a specific fund and the balance left before they meet their pledge. If the person does not have a pledge, the pledge amount will show as 0.00. If they have given toward that fund, but not made a pledge the balance amount will show 0.00. If they have given more than their pledge, the balance amount will be the overage amount preceded by a minus ("-"). Because you may have multiple pledge funds, you indicate the fund ID in the replacement code. .. caution:: You can use these 2 pledge replacement codes for only one pledge fund in each email. So, if you want to update your members and you have 2 pledge funds, send out one email for each fund. ``{pledgeamt:100}`` Where 100 is the fund id. Shows amount of pledge made for that fund. ``{pledgebal:100}`` Where 100 is the fund id. Shows balance due based on pledge for that fund. Continue Registration Link Email -------------------------------- ``[registration for {orgname}]`` This will present the name of the Involvement (or the Registration Title if there is one). The brackets and curly braces will not display. This is used when Allow Save Progress is checked for an online registration. DiffEmailMessage or NoEmailMessage ---------------------------------- ``{contactphone}`` Number on the online registration Involvement - `Setting > General` CreateAccount ------------- Only a System Administrator can use this email replacement code. It can be sent to people who are in the database, but who do not have user accounts. ``{createaccount}`` This link will create a user account and send the person an email with their username and link to create their password. .. seealso:: :doc:`CreateAccount` SMS Texting Replacement Codes ----------------------------- ``{altname}`` This will populate the Alt Name from the people record of the recipient. If you also include {first}, both will appear to recipient. ``{churchaddress}`` This will insert the church address that is in your database Settings. ``{churchname}`` This will insert the church name that is in your database Settings. ``{extradata:field}`` This will insert the value from the person's record for a Single Line Extra Value. Replace "field" with the EV name. ``{familyextratext:CoupleName}`` For the Family Extra Value called CoupleName ``{familyname}`` This will insert the value for the Family Extra Value called FamilyName. ``{firstorjoint}`` How this works is dependent on the Contribution Type of the individuals. It will use the person's first name if the person has a Contribution Type of Individual. It will use the two Primary Adults' first names (John & Mary) if the couple each has a Contribution Type of Joint. If both spouses are included in the recipient list, they will each get the email addressed to both of them (John & Mary) if they give jointly. You can filter out one spouse by adding the Condition "Is Head of Household" = true, then the husband will receive the email addressed to both of them. If you add that Condition and you have couples that give individually the email will go only to the HOH and will be addressed only to him/her. Just think how you want to use this and create your searches accordingly. .. _Scheduler: Scheduler --------- These are specifically designed to work in a Scheduler involvement: ``{first}`` First Name of recipient or preferred name if there is one ``{details}`` For the Scheduler Registration Confirmation Template. Provides the Day of Week, Date and Time of the time slot. ``{org}`` Included in the Registration Confirmation Template. Provides the name of the Scheduler. ``{person}`` Included in the Scheduler Commitment - Notify, Scheduler Commitment Cancelled - Notify, and Scheduler Requested Sub - Notify Templates. Notifies staff who made a Scheduler commitment. ``{requestor}`` Included in the Scheduler Sub Confirmation Template. Confirms to sub who they are subbing for. ``{sendername}`` Included in the Scheduler Request More People Template. Provide name of person requesting subs. ``{meetingdate}`` For use in the Scheduler Sub Request Template, Scheduler Sub Confirmation Template, and Scheduler Reminder Template ``{meetingtime}`` For use in the Scheduler Sub Request Template, Scheduler Sub Confirmation Template, and Scheduler Reminder Template ``{team/sg}`` For use in the Scheduler Sub Request Template, Scheduler Sub Confirmation Template, and Scheduler Reminder Template .. note:: **{meetingdate}**, **{meetingtime}** and **{team/sg}** need to ALL be included in the template to work properly. .. _Ticketing: Ticketing --------- These will only work in conjuction with TouchPoint Ticketing. .. seealso:: :doc:`/Ticketing/TicketingInTouchPoint` Ticketing confirmation email: ``{mytickets:1234,Please follow this link to view all your e-tickets.}`` Replace 1234 with the Involvement ID of the Ticketing Involvement. You can also replace the wording after the comma, which will render as the link in the email. This link will take the registrant to a My Tickets page. ``{canceltickets}`` Provides a link for the registrant to cancel their tickets from the confirmation email. *This is a one-time link and will cancel ALL of the users' tickets within the order.* (Not for use in reminder email.) .. note:: We recommend you use {mytickets} replacement code in the confirmation email rather than using {canceltickets}. The {canceltickets} will only allow the attendee to cancel ALL tickets, where {mytickets} allows them to choose single tickets for release. | ``{canceltickets:CLICK HERE}`` Replace CLICK HERE with any text you choose to customize the Cancel Tickets text. *This is a one-time link and will cancel ALL of the users' tickets within the order.* (Not for use in reminder email.) ``{eventday}`` Provides the day of the week of the event in the confirmation email. ``{ordernumber}`` Provides the order number which also appears in the Ticket Sales report. Ticketing text: ``{mytickets:1234}`` Replace 1234 with the Involvement ID of the Ticketing Involvement | | +--------------------+------------------+ | **Latest Update** | **3/13/2024** | +--------------------+------------------+ Added Scheduler replacement codes