ListMergeFields
Returns merge fields for a Mailchimp list. Merge fields map to subscriber profile data, such as first name or address, and were previously referred to as merge vars.
Table-Specific Information
Select
The provider uses the Mailchimp API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the provider.
| Column | Supported Operators |
| MergeId | = |
| ListId | = |
| Type | = |
| Required | = |
SELECT * FROM ListMergeFields WHERE ListId = 'abc'
SELECT * FROM ListMergeFields WHERE Type = 'address'
SELECT * FROM ListMergeFields WHERE Required = 'true'
SELECT * FROM ListMergeFields WHERE ListId = 'abc' AND MergeId = '595'
Insert
The Name and ListId columns are required for INSERT operations.
INSERT INTO ListMergeFields (Name, ListId) VALUES ('myNewListMergeField', 'myListId')
Columns
| Name | Type | ReadOnly | References | Description |
| MergeId [KEY] | Integer | True |
A unique Id for the merge field that does not change. | |
| Tag | String | False |
The tag used in MailChimp campaigns and for the /members endpoint. | |
| Name | String | False |
The display name of the merge field as defined in the MailChimp list. | |
| Type | String | False |
The type for the merge field. The allowed values are text, number, address, phone, date, url, imageurl, radio, dropdown, birthday, zip. | |
| Required | Boolean | False |
Boolean value indicating whether the merge field is required. | |
| DefaultValue | String | False |
The default value for the merge field if null. | |
| Public | Boolean | False |
Whether or not the merge field is displayed on the signup form. | |
| DisplayOrder | Long | False |
The order on the form where the merge field is displayed. | |
| Options_DefaultCountry | Integer | False |
In an address field, the default country code if none supplied. | |
| Options_PhoneFormat | String | False |
In a phone field, the phone number type: US or International. | |
| Options_DateFormat | String | False |
In a date or birthday field, the format of the date. | |
| Options_Choices | String | False |
In a radio or dropdown non-group field, the available options for members to pick from. | |
| Options_Size | Long | False |
The default length of a text field. | |
| HelpText | String | False |
Any extra text to help the subscriber. | |
| ListId [KEY] | String | False |
Lists.Id |
A string that identifies the list of merge field collections. |