Lists
Contains all audience lists in the account, including configuration details, subscriber counts, and opt-in settings.
Table Specific Information
SELECT, INSERT, UPDATE, and DELETE are supported for Lists.
Select
The add-in will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the add-in.
- Id supports the '=' operator.
- DateCreated supports the '=,<,>,<=,>=' operator.
- Stats_CampaignLastSent supports the '=,<,>,<=,>=' operator.
SELECT * FROM Lists WHERE Id = 'abc' SELECT * FROM Lists WHERE DateCreated = '2024-02-07 00:00:37.0' SELECT * FROM Lists WHERE DateCreated >= '2024-02-07 00:00:37.0' SELECT * FROM Lists WHERE DateCreated <= '2024-02-07 00:00:37.0' SELECT * FROM Lists WHERE DateCreated > '2024-02-07 00:00:37.0' SELECT * FROM Lists WHERE DateCreated < '2024-02-07 00:00:37.0'
Insert
The Name, PermissionReminder, EmailTypeOption, Contact_Company, Contact_Address1, Contact_City, Contact_State, Contact_Zip, Contact_Country, CampaignDefaults_FromName, CampaignDefaults_FromEmail, CampaignDefaults_Subject, and CampaignDefaults_Language are required for INSERTs.
INSERT INTO Lists (Name, PermissionReminder, EmailTypeOption, Contact_Company, Contact_Address1, Contact_City, Contact_State, Contact_Zip, Contact_Country, CampaignDefaults_FromName, CampaignDefaults_FromEmail, CampaignDefaults_Subject, CampaignDefaults_Language) VALUES ('myName', 'myPermissionReminder', 'true', 'myCompany', 'myAddress', 'myCity', 'myState', 'myZip', 'myCountry', 'myFromName', 'myFromEmail', 'myDefaultSubject', 'myDefaultLanguage')
Columns
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | True |
The unique identifier of the audience (list) within the Mailchimp account. |
| Name | String | False |
The display name of the audience, used for identifying it in the Mailchimp dashboard. |
| Contact_Company | String | False |
The company name associated with the audience's contact information, typically appearing in campaign footers. |
| Contact_Address1 | String | False |
The primary street address associated with the audience contact. |
| Contact_Address2 | String | False |
An additional address line for the audience contact. |
| Contact_City | String | False |
The city specified in the audience's contact address. |
| Contact_State | String | False |
The state or province for the audience contact address. |
| Contact_Zip | String | False |
The postal or ZIP code for the audience contact address. |
| Contact_Country | String | False |
The two-letter ISO 3166 country code for the contact's country. If the provided code is not valid, it defaults to 'US'. |
| Contact_Phone | String | False |
The phone number associated with the audience contact. |
| PermissionReminder | String | False |
A short message displayed in email footers reminding subscribers why they are receiving the campaign. |
| UseArchiveBar | Boolean | False |
Indicates whether campaign archives for this audience include the Mailchimp Archive Bar by default. |
| CampaignDefaults_FromName | String | False |
The default 'from' name that appears in campaigns sent to this audience. |
| CampaignDefaults_FromEmail | String | False |
The default 'from' email address used in campaigns sent to this audience. It must be a valid email address. |
| CampaignDefaults_Subject | String | False |
The default subject line applied to campaigns sent to this audience. |
| CampaignDefaults_Language | String | False |
The default language used for the audience's signup forms and notifications. |
| NotifyOnSubscribe | String | False |
An optional email address to receive notifications when a new contact subscribes to the audience. |
| NotifyOnUnsubscribe | String | False |
An optional email address to receive notifications when a contact unsubscribes from the audience. |
| DateCreated | Datetime | True |
The date and time when the audience was originally created. |
| ListRating | Integer | True |
An automatically generated activity score for the audience ranging from 0 to 5. |
| EmailTypeOption | Boolean | False |
Indicates whether the audience supports sending emails in multiple formats (HTML and plain text). |
| SubscribeUrlShort | String | True |
A shortened URL version of the audience's signup form, generated by Mailchimp (eepurl). |
| SubscribeUrlLong | String | True |
The full URL for the audience's signup form, hosted by Mailchimp. |
| BeamerAddress | String | True |
The unique email address used to post directly to the audience via Mailchimp's Email Beamer feature. |
| Visibility | String | False |
Defines whether the audience is public ('pub') or private ('prv') within Mailchimp projects such as Wavelength. |
| Modules | String | True |
Specifies any audience-specific modules or integrations installed for this list. |
| Stats_MemberCount | Integer | True |
The total number of active subscribers in the audience. |
| Stats_UnsubscribeCount | Integer | True |
The total number of contacts who have unsubscribed from the audience. |
| Stats_CleanedCount | Integer | True |
The total number of contacts removed due to invalid or bounced email addresses. |
| Stats_MemberCountSinceSend | Integer | True |
The number of active subscribers added since the last campaign was sent. |
| Stats_UnsubscribeCountSinceSend | Integer | True |
The number of unsubscribes recorded since the last campaign was sent. |
| Stats_CleanedCountSinceSend | Integer | True |
The number of cleaned (bounced) addresses since the last campaign was sent. |
| Stats_CampaignCount | Integer | True |
The total number of campaigns, across all statuses, that have used this audience. |
| Stats_CampaignLastSent | Datetime | True |
The date and time the most recent campaign was sent to this audience. |
| Stats_MergeFieldCount | Integer | True |
The total number of merge fields configured for this audience, excluding the required EMAIL field. |
| Stats_AvgSubRate | Double | True |
The average number of new subscriptions per month for the audience, if calculated. |
| Stats_AvgUnsubRate | Double | True |
The average number of unsubscribes per month for the audience, if calculated. |
| Stats_TargetSubRate | Double | True |
The target number of new subscriptions per month needed to maintain growth, if calculated. |
| Stats_OpenRate | Double | True |
The average open rate (as a percentage) for campaigns sent to this audience. |
| Stats_ClickRate | Double | True |
The average click-through rate (as a percentage) for campaigns sent to this audience. |
| Stats_LastSubDate | Datetime | True |
The date and time when the most recent subscription was added to the audience. |
| Stats_LastUnsubDate | Datetime | True |
The date and time when the most recent unsubscribe occurred. |
| WebId | Integer | True |
The audience ID used in the Mailchimp web interface. You can view it in your account at https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}. |
| DoubleOptin | Boolean | False |
Indicates whether the audience requires double opt-in confirmation via email before adding new subscribers. |
| HasWelcome | Boolean | True |
Specifies whether the audience has a connected welcome automation, such as 'welcomeSeries' or 'singleWelcome'. |
| MarketingPermissions | Boolean | False |
Indicates whether marketing permissions like General Data Protection Regulation (GDPR) consent are enabled for this audience. |
| Stats_TotalContacts | Integer | True |
The total number of contacts in the audience, including subscribed, unsubscribed, pending, cleaned, and transactional statuses. It requires the include_total_contacts parameter in queries. |