Endpoint

Add New List

Name

add_list

Description

Create a new list in your Mailchimp account. [API reference]

Related Tables

Lists

Parameters

Parameter	Label	Required	Options	Description
There are no parameters

Output Columns

Label	Data Type (SSIS)	Data Type (SQL)	Length	Raw
Id	`DT_WSTR`	`nvarchar(100)`	100	`False`
WebId	`DT_I4`	`int`		`False`
Name	`DT_WSTR`	`nvarchar(100)`	100	`False`
Company	`DT_WSTR`	`nvarchar(500)`	500	`False`
Address1	`DT_WSTR`	`nvarchar(500)`	500	`False`
Address2	`DT_WSTR`	`nvarchar(500)`	500	`False`
City	`DT_WSTR`	`nvarchar(100)`	100	`False`
State	`DT_WSTR`	`nvarchar(100)`	100	`False`
Zip	`DT_WSTR`	`nvarchar(100)`	100	`False`
Country	`DT_WSTR`	`nvarchar(100)`	100	`False`
Phone	`DT_WSTR`	`nvarchar(100)`	100	`False`
PermissionReminder	`DT_WSTR`	`nvarchar(4000)`	4000	`False`
UseArchiveBar	`DT_BOOL`	`bit`		`False`
CampaignDefaultFromName	`DT_WSTR`	`nvarchar(100)`	100	`False`
CampaignDefaultFromEmail	`DT_WSTR`	`nvarchar(500)`	500	`False`
CampaignDefaultSubject	`DT_WSTR`	`nvarchar(500)`	500	`False`
CampaignDefaultLanguage	`DT_WSTR`	`nvarchar(100)`	100	`False`
NotifyOnSubscribe	`DT_WSTR`	`nvarchar(500)`	500	`False`
NotifyOnUnsubscribe	`DT_WSTR`	`nvarchar(500)`	500	`False`
DateCreated	`DT_DBTIMESTAMP`	`datetime`		`False`
ListRating	`DT_I4`	`int`		`False`
EmailTypeOption	`DT_BOOL`	`bit`		`False`
SubscribeUrlShort	`DT_WSTR`	`nvarchar(512)`	512	`False`
SubscribeUrlLong	`DT_WSTR`	`nvarchar(1024)`	1024	`False`
BeamerAddress	`DT_WSTR`	`nvarchar(500)`	500	`False`
Visibility	`DT_WSTR`	`nvarchar(100)`	100	`False`
DoubleOptin	`DT_BOOL`	`bit`		`False`
HasWelcome	`DT_BOOL`	`bit`		`False`
MarketingPermissions	`DT_BOOL`	`bit`		`False`
Modules	`DT_WSTR`	`nvarchar(500)`	500	`False`
MemberCount	`DT_I4`	`int`		`False`
UnsubscribeCount	`DT_I4`	`int`		`False`
CleanedCount	`DT_I4`	`int`		`False`
MemberCountSinceSend	`DT_I4`	`int`		`False`
UnsubscribeCountSinceSend	`DT_I4`	`int`		`False`
CleanedCountSinceSend	`DT_I4`	`int`		`False`
CampaignCount	`DT_I4`	`int`		`False`
CampaignLastSent	`DT_WSTR`	`nvarchar(500)`	500	`False`
MergeFieldCount	`DT_I4`	`int`		`False`
AvgSubRate	`DT_I4`	`int`		`False`
AvgUnsubRate	`DT_I4`	`int`		`False`
TargetSubRate	`DT_I4`	`int`		`False`
OpenRate	`DT_I4`	`int`		`False`
ClickRate	`DT_I4`	`int`		`False`
LastSubDate	`DT_DBTIMESTAMP`	`datetime`		`False`
LastUnsubDate	`DT_DBTIMESTAMP`	`datetime`		`False`

If the column you are looking for is missing, consider customizing Mailchimp Connector.

Input Columns

Label	Data Type (SSIS)	Data Type (SQL)	Length	Raw	Description
Name	`DT_WSTR`	`nvarchar(200)`	200	`False`	The name of the list.
Company	`DT_WSTR`	`nvarchar(200)`	200	`False`	The company name for the list.
Address1	`DT_WSTR`	`nvarchar(200)`	200	`False`	Line 1 of the street address for the list contact.
City	`DT_WSTR`	`nvarchar(200)`	200	`False`	The city for the list contact.
Country	`DT_WSTR`	`nvarchar(200)`	200	`False`	A two-character ISO3166 country code. Defaults to US if invalid.
PermissionReminder	`DT_WSTR`	`nvarchar(500)`	500	`False`	The permission reminder for the list.
CampaignDefaultFromName	`DT_WSTR`	`nvarchar(200)`	200	`False`	The default from name for campaigns sent to this list.
CampaignDefaultFromEmail	`DT_WSTR`	`nvarchar(200)`	200	`False`	The default from email for campaigns sent to this list.
CampaignDefaultSubject	`DT_WSTR`	`nvarchar(200)`	200	`False`	The default subject line for campaigns sent to this list.
CampaignDefaultLanguage	`DT_WSTR`	`nvarchar(200)`	200	`False`	The default language for this lists's forms.
EmailTypeOption	`DT_WSTR`	`nvarchar(4000)`	4000	`True`	Whether the list supports multiple formats for emails. When set to true, subscribers can choose whether they want to receive HTML or plain-text emails. When set to false, subscribers will receive HTML emails, with a plain-text alternative backup.
DoubleOptIn	`DT_WSTR`	`nvarchar(4000)`	4000	`True`	Whether or not to require the subscriber to confirm subscription via email.
Address2	`DT_WSTR`	`nvarchar(200)`	200	`False`	Line 2 of the street address for the list contact.
State	`DT_WSTR`	`nvarchar(20)`	20	`False`	The state for the list contact.
Zip	`DT_WSTR`	`nvarchar(20)`	20	`False`	The postal or zip code for the list contact.
Phone	`DT_WSTR`	`nvarchar(30)`	30	`False`	The phone number for the list contact.
UseArchiveBar	`DT_WSTR`	`nvarchar(4000)`	4000	`True`	Whether campaigns for this list use the Archive Bar in archives by default.
NotifyOnSubscribe	`DT_WSTR`	`nvarchar(200)`	200	`False`	The email address to send subscribe notifications to.
NotifyOnUnsubscribe	`DT_WSTR`	`nvarchar(200)`	200	`False`	The email address to send unsubscribe notifications to.
MarketingPermissions	`DT_WSTR`	`nvarchar(4000)`	4000	`True`	Whether or not the list has marketing permissions (eg. GDPR) enabled.

Required columns that you need to supply are bolded.

Examples

SSIS

Use Mailchimp Connector in API Source component to read data or in API Destination component to read/write data:

Insert into Lists table using API Destination

This Endpoint belongs to Lists table, therefore you cannot work with it directly. Use this table and table-operation pair instead:

Mailchimp

Lists

Insert

SSIS API Destination - Access table operation

ODBC application

Use these SQL queries in your ODBC application data source:

Create a new list/audience in your Mailchimp account

INSERT INTO Lists
(Name, Company, Address1, Address2, City, State, Zip, Country, Phone, PermissionReminder, UseArchiveBar, CampaignDefaultFromName, CampaignDefaultFromEmail, CampaignDefaultSubject, CampaignDefaultLanguage, NotifyOnSubscribe, NotifyOnUnsubscribe, EmailTypeOption, DoubleOptIn, MarketingPermissions)
VALUES
('The Awesome List', 'My Company Name', '123 Morgan Falls Lane', 'Suite 250','Albany', 'GA', '30114', 'US', '(770) 555-1234', 'Thank you for signing up for these notification emails!', 'false', 'Sales Team', 'salesteam@mycompany.com', 'The best deals are here!', 'en', 'salesteam@mycompany.com', 'salesteam@mycompany.com', 'true', 'false', 'true')

add_list endpoint belongs to Lists table(s), and can therefore be used via those table(s).

SQL Server

Use these SQL queries in SQL Server after you create a data source in Data Gateway:

Create a new list/audience in your Mailchimp account

DECLARE @MyQuery NVARCHAR(MAX) = 'INSERT INTO Lists
(Name, Company, Address1, Address2, City, State, Zip, Country, Phone, PermissionReminder, UseArchiveBar, CampaignDefaultFromName, CampaignDefaultFromEmail, CampaignDefaultSubject, CampaignDefaultLanguage, NotifyOnSubscribe, NotifyOnUnsubscribe, EmailTypeOption, DoubleOptIn, MarketingPermissions)
VALUES
(''The Awesome List'', ''My Company Name'', ''123 Morgan Falls Lane'', ''Suite 250'',''Albany'', ''GA'', ''30114'', ''US'', ''(770) 555-1234'', ''Thank you for signing up for these notification emails!'', ''false'', ''Sales Team'', ''salesteam@mycompany.com'', ''The best deals are here!'', ''en'', ''salesteam@mycompany.com'', ''salesteam@mycompany.com'', ''true'', ''false'', ''true'')';

EXEC (@MyQuery) AT [LS_TO_MAILCHIMP_IN_GATEWAY];

add_list endpoint belongs to Lists table(s), and can therefore be used via those table(s).