Lists
Returns a collection of subscriber lists associated with this account. Lists contain subscribers who have opted in to receive correspondence from the account holder or their organization.
Table-Specific Information
SELECT, INSERT, UPDATE, and DELETE are supported for Lists.
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 |
| Id | = |
| DateCreated | =, <, >, <=, >= |
| Stats_CampaignLastSent | =, <, >, <=, >= |
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'
Additionally, the DateCreated column can be used in the ORDER BY clause, as follows:
SELECT * FROM Lists ORDER BY DateCreated DESC
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 columns are required for INSERT operations.
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 | References | Description |
| Id [KEY] | String | True |
The unique identifier for this list. | |
| Name | String | False |
The name of the list. | |
| Contact_Company | String | False |
The company name associated with the list. | |
| Contact_Address1 | String | False |
The street address for the list contact. | |
| Contact_Address2 | String | False |
The secondary street address for the list contact. | |
| Contact_City | String | False |
The city for the list contact. | |
| Contact_State | String | False |
The state for the list contact. | |
| Contact_Zip | String | False |
The postal or zip code for the list contact. | |
| Contact_Country | String | False |
The two-character ISO 3166 country code. Defaults to US if invalid. | |
| Contact_Phone | String | False |
The phone number for the list contact. | |
| PermissionReminder | String | False |
The permission reminder for the list: a line of text that appears in the footer of each campaign that explains why subscribers are receiving the email campaign. | |
| UseArchiveBar | Boolean | False |
Indicates whether campaigns for this list use the Archive Bar in archives by default. | |
| CampaignDefaults_FromName | String | False |
The default from name for campaigns sent to this list. | |
| CampaignDefaults_FromEmail | String | False |
The default from email (must be a valid email address) for campaigns sent to this list. | |
| CampaignDefaults_Subject | String | False |
The default subject line for campaigns sent to this list. | |
| CampaignDefaults_Language | String | False |
The default language for this list's forms. | |
| NotifyOnSubscribe | String | False |
The email address to send subscribe notifications to, when enabled. | |
| NotifyOnUnsubscribe | String | False |
The email address to send unsubscribe notifications to, when enabled. | |
| DateCreated | Datetime | True |
The date and time that this list was created. | |
| ListRating | Integer | True |
An auto-generated activity score for the list (0-5). | |
| EmailTypeOption | Boolean | False |
Indicates whether the list supports multiple formats for emails. | |
| SubscribeUrlShort | String | True |
The shortened eepurl version of this list's subscribe form URL. | |
| SubscribeUrlLong | String | True |
The full URL of this list's subscribe form. The host may vary. | |
| BeamerAddress | String | True |
The email address to use for this list's Email Beamer. | |
| Visibility | String | True |
The visibility setting for this list, indicating whether it is public (pub) or private (prv). Used internally for projects like Wavelength. The allowed values are pub, prv. | |
| Modules | String | True |
Any list-specific modules installed for this list. | |
| Stats_MemberCount | Integer | True |
The number of active members in the given list. | |
| Stats_UnsubscribeCount | Integer | True |
The number of members who have unsubscribed from the given list. | |
| Stats_CleanedCount | Integer | True |
The number of members cleaned from the given list. | |
| Stats_MemberCountSinceSend | Integer | True |
The number of active members in the given list since the last campaign was sent. | |
| Stats_UnsubscribeCountSinceSend | Integer | True |
The number of members who have unsubscribed since the last campaign was sent. | |
| Stats_CleanedCountSinceSend | Integer | True |
The number of members cleaned from the given list since the last campaign was sent. | |
| Stats_CampaignCount | Integer | True |
The number of campaigns in any status that use this list. | |
| Stats_CampaignLastSent | Datetime | True |
The date and time the last campaign was sent to this list. | |
| Stats_MergeFieldCount | Integer | True |
The number of merge fields for this list, not including the required EMAIL field. | |
| Stats_AvgSubRate | Double | True |
The average number of subscriptions per month for the list. This value is not returned if it has not been calculated yet. | |
| Stats_AvgUnsubRate | Double | True |
The average number of unsubscriptions per month for the list. This value is not returned if it has not been calculated yet. | |
| Stats_TargetSubRate | Double | True |
The target number of subscriptions per month for the list to keep it growing. This value is not returned if it has not been calculated yet. | |
| Stats_OpenRate | Double | True |
The average open rate per campaign for the list, represented as a percentage between 0 and 100. This value is not returned if it has not been calculated yet. | |
| Stats_ClickRate | Double | True |
The average click rate per campaign for the list, represented as a percentage between 0 and 100. This value is not returned if it has not been calculated yet. | |
| Stats_LastSubDate | Datetime | True |
The date and time of the last time someone subscribed to this list. | |
| Stats_LastUnsubDate | Datetime | True |
The date and time of the last time someone unsubscribed from this list. | |
| WebId | Integer | True |
The Id used in the Mailchimp web application. | |
| DoubleOptin | Boolean | False |
Indicates whether subscribers are required to confirm their subscription via email. | |
| HasWelcome | Boolean | True |
Indicates whether this list has a welcome automation connected. Welcome automation types include welcomeSeries, singleWelcome, and emailFollowup. | |
| MarketingPermissions | Boolean | False |
Indicates whether the list has marketing permissions (such as GDPR) enabled. | |
| Stats_TotalContacts | Integer | True |
The number of contacts in the list, including subscribed, unsubscribed, pending, cleaned, deleted, and transactional contacts, as well as those that need to be reconfirmed. Requires the include_total_contacts query parameter. |