Merge Symbol

Overview

The Merge Symbol endpoint is used request information about the Merge Symbols used in your Campaigns.

Merge Symbols are textual representations of field names, and are used when personalizing the content of a message. For example, instead of using "Hello Customer" as a greeting, you could replace "Customer" with the recipient's actual first name, by pulling values from a "first name" field in your source table. Within the Advanced Editor, the platform would display this statement using a Merge Symbols such as: "Hello {(first_name)}."

When you add a personalization field to your message content, you can optionally apply a formatting mask to the field. The formatting mask is used to control the appearance of the text in the field. For example, you can format date fields as "mm/dd/yyyy." The selected formatting mask is represented within the Merge Symbol using a variety of different codes. Continuing the previous example, the "mm/dd/yy" date field format mask is represented by the code: "d:d." Therefore, the Merge Symbol for this field would be: "{(date_field||d:d)}."

Merge Symbols are also used when you insert items, such as Content Blocks, into the content of a message. For example, let's say you inserted a Content Block named "Silver Rewards Content" into a message. Within the Advanced Editor, the platform would represent this Content Block using a Merge Symbol consisting of the Block's name and Object Reference ID enclosed in double-brackets. For example: "{(Silver Rewards Content|8687)}."

Endpoint (North America): https://api.eccmp.com/services2/api/MergeSymbol
Endpoint (Europe): https://api.ccmp.eu/services2/api/MergeSymbol
Endpoint (Japan): https://api.marketingsuite.jp/services2/api/MergeSymbol

For more details on the Merge Symbol API, please see the Merge Symbol API Technical Guide.

GET Method

The Merge Symbol endpoint supports the following GET operations.

Retrieve Merge Symbols for System Fields

This endpoint allows you to retrieve a list of the Merge Symbols for various system fields and your custom metadata fields (see Metadata Settings for more details on your custom metadata fields).