REST Email Marketing API Documentation

MAIL MERGE TAGS

Symphonie features many mail merge tags that can be added as simple HTML. Some commands, such as the ones for dynamic content, require the web interface to be built correctly. Here are the tags that can be added within the HTML or text section, using the default mail merge delimiters:

Barcode A tag that will allow the dynamic creation of UPC-style barcodes, as well as data matrixes and QR codes. Create using the web interface.
Code This tag allows execution of custom mail merge tags you have defined in C# or VB code. Create using the web interface.
Content Block (static) This tag causes a content block to be substituted unconditionally at the tag position. Create using the web interface.
Demographics Displays the content of a specific demographic column to the recipient. This helps personalize message content, for example, to display the recipient’s age, gender or other individual recipient demographic information. Format: [-DBColumn Age-] where Age is the example demographic name.
Email Address Substitutes the recipient’s email address. Format: [-EmailAddress-]
Forward The link to take recipients to a page to allow them to enter the email addresses of a person who should get a copy of the content. For the HTML section, normally wrapped in an A tag: <a href="[-Forward-]">Forward this content</a>
Global Unsubscribe URL Generates a link to a page that provides a recipient means to indicate that they don’t want to receive any mail from you again, regardless of the topic of the mail. Example: "Click <a href="[-GlobalUnsubscribeUrl-]">here</a> to globally unsubscribe."
Manage Subscriptions URL Creates a link to a page that allows recipients to manage their own settings, so they can change their topic subscriptions or email address. For the HTML section it is normally wrapped in an A tag: "Manage your subscriptions <a href="[-ManageSubscriptionsUrl-]">here</<a>"
Name/Email Displays the contents of the Name field in the message. If the recipient's name is not available, it displays the recipient's email address. Format: [-NameEmail-]
Recipient Name Displays the individual recipient name in the message to help personalize the content. Format: [-RecipientName-]
Refer a friend The link to take recipients to a page to allow them to enter the email addresses of their friends who will be encouraged to join the list. Compose a link like: <a href="[-Refer 0-]">here</a>
Referral Summary Build a link that allows recipients to see how many referrals have subscribed. Example: "Click <a href="[-ReferralSummary-]">here</a> to see how your referrals are doing."
Topic Unsubscribe URL Creates a link to a page that allows recipients to unsubscribe from your email offering. Example: "Click <a href="[-TopicUnsubscribeUrl-]">here</a> to unsubscribe from this topic."
View HTML in Browser This builds a link that will take the recipient to a web page that shows the rendered HTML content. Example: "<a href="[-ViewInBrowser-]">View HTML in browser</a>"
View Plain Text in Browser This builds a link that will take the recipient to a web page that shows the rendered plain text content. Example: "<a href="[-ViewPlainText-]">View plain text in browser</<a>"

In addition, there is one mail merge tag that only works with Documents:

DynamicTag This tag substitutes information provided by the API call directly into the message for the ultimate in real-time customization ability. Format: [-DynamicTag SalesPrice-] where SalesPrice is the name provides during the API call.

As a user of Goolara Symphonie, the REST API is free and included in the latest version of the software. If you have any questions about using Symphonie’s REST API, feel free to contact us.