Mailchimp Connector for SSIS
In this article you will learn how to quickly and efficiently
integrate Mailchimp data in SSIS without coding.
We will use high-performance Mailchimp Connector
to easily connect to Mailchimp and then access the data inside SSIS.
Read / write MailChimp Campaigns, Lists, Members, Reports and more in without coding.
Let's follow the steps below to see how we can accomplish that!
Download
Documentation
Mailchimp Connector for SSIS is based on ZappySys API Connector Framework
which is a part of SSIS PowerPack.
It is a collection of high-performance SSIS connectors that enable you
to integrate data with virtually any data provider supported by SSIS, including SQL Server.
SSIS PowerPack supports various file formats, sources and destinations,
including REST/SOAP API, SFTP/FTP, storage services, and plain files, to mention a few
(if you are new to SSIS and SSIS PowerPack, find out more on how to use them).
|
Connect to Mailchimp in other apps
|
Video Tutorial - Integrate Mailchimp data in SSIS
This video covers following and more so watch carefully. After watching this video follow the steps described in this article.
- How to download / install required driver for Mailchimp integration in SSIS
- How to configure connection for Mailchimp
- Features about API Source (Authentication / Query Language / Examples / Driver UI)
- Using Mailchimp Connection in SSIS
Prerequisites
Before we begin, make sure the following prerequisites are met:
-
SSIS designer installed.
Sometimes it is referred as BIDS or SSDT
(download it from Microsoft).
-
Basic knowledge of SSIS package development using
Microsoft SQL Server Integration Services.
-
SSIS PowerPack
is installed
(if you are new to SSIS PowerPack, then get started!).
Read data from Mailchimp in SSIS (Export data)
In this section we will learn how to configure and use Mailchimp Connector in API Source to extract data from Mailchimp.
-
Begin with opening Visual Studio and Create a New Project.
Select Integration Service Project and in new project window set the appropriate name and location for project. And click OK.
-
In the new SSIS project screen you will find the following:
- SSIS ToolBox on left side bar
- Solution Explorer and Property Window on right bar
- Control flow, data flow, event Handlers, Package Explorer in tab windows
- Connection Manager Window in the bottom
Note: If you don't see ZappySys SSIS PowerPack Task or Components in SSIS Toolbox, please refer to
this help link.
-
Now, Drag and Drop SSIS Data Flow Task from SSIS Toolbox. Double click on the Data Flow Task to see Data Flow designer.
-
From the SSIS toolbox drag and API Source (Predefined Templates) on the data flow designer surface, and double click on it to edit it:
-
Select New Connection to create a new connection:
-
Use a preinstalled Mailchimp Connector from Popular Connector List or press Search Online radio button to download Mailchimp Connector. Once downloaded simply use it in the configuration:
Mailchimp
-
Proceed with selecting the desired Authentication Type. Then select API Base URL (in most cases default one is the right one). Finally, fill in all the required parameters and set optional parameters if needed. You may press a link Steps to Configure which will help set certain parameters. More info is available in Authentication section.
Steps how to get and use Mailchimp credentials
To get the credentials you need in order to set up your OAuth workflow, you'll first need to register your application with Mailchimp:
-
Login into your Mailchimp account, click on your Profile Icon, and hit Account & billing:
-
Navigate to the Registered Apps page in your Mailchimp account:
-
Click Register An App button:
-
Fill-in the Register An App form and click Create button:
NOTE:
For Redirect URI use Redirect URI (also called "Redirect URL" or "Callback URL") given by your IT administrator
or just use https://zappysys.com/oauth
, if you don't have one.
-
After successfully registering your application,
you'll see the Client ID and Client Secret,
record these values and store them securely:
-
Record your Mailchimp data center, since we will need it later.
The data center is located in your browser's address bar URL.
If the URL is
https://us21.admin.mailchimp.com/account/api
, then your data center is us21
.
-
Now go to SSIS package or ODBC data source OAuth authentication configuration.
-
Proceed by entering the data center into the Data Center field that was recorded in the previous step.
-
Then enter the Client ID value into the Client ID field that you recorded in the previous step.
-
Enter the Client Secret value into the Client Secret field that was recorded in the previous step.
-
Click Generate Token.
If proper authentication occurs, you will see a confirmation notice.
If you get an error, click Yes on the dialog box and then a large browser window will launch.
Then log into your Mailchimp account and approve the use of the application.
-
Finally, hit the Test Connection button at the bottom of the window to verify proper connectivity with your Mailchimp account.
-
If the connection test succeeds, select OK.
-
Done! Now you can use Mailchimp Connector!
Configuring authentication parameters
Mailchimp
OAuth [OAuth]
https://[$DataCenter$].api.mailchimp.com
Steps how to get and use Mailchimp credentials
The simplest way to authenticate a request to the Mailchimp Marketing API is by using an API key (If you require access to Mailchimp on behalf of other Mailchimp users, you'll want to set up OAuth authentication instead)::
-
Login into your Mailchimp account, click on your Profile Icon, and hit Account & billing:
-
Navigate to the API keys page in your Mailchimp account:
-
In the Your API keys section of the page, click Create A Key button:
-
Give your new key a descriptive name that will remind you which application it's used for:
-
Copy the API key immediately and store it in a secure location (you won't be able to see or copy the key once you finish generating it):
-
Record your Mailchimp data center, since we will need it later.
The data center is located in your browser's address bar URL.
If the URL is
https://us21.admin.mailchimp.com/account/api
, then your data center is us21
.
-
Now go to SSIS package or ODBC data source ApiKey Auth authentication configuration.
-
Proceed by entering the data center into the Data Center field that was recorded in the previous step.
-
Then enter the API key into the Api Key field that you copied earlier.
-
Finally, click the Test Connection button at the bottom of the window to verify proper connectivity with your Mailchimp account.
-
Done! Now you can use Mailchimp Connector!
Configuring authentication parameters
Mailchimp
ApiKey Auth [Http]
https://[$DataCenter$].api.mailchimp.com
-
Select the desired endpoint, change/pass the properties values, and click on Preview Data button to make the API call.
API Source - Mailchimp
Read / write MailChimp Campaigns, Lists, Members, Reports and more in without coding.
-
That's it! We are done! Just in a few clicks we configured the call to Mailchimp using Mailchimp Connector.
You can load the source data into your desired destination using the Upsert Destination, which supports SQL Server, PostgreSQL, and Amazon Redshift. We also offer other destinations such as CSV, Excel, Azure Table, Salesforce, and more. You can check out our SSIS PowerPack Tasks and components for more options. (*loaded in Trash Destination)
Write data to Mailchimp using SSIS (Import data)
In this section we will learn how to configure and use Mailchimp Connector in the API Destination to write data to Mailchimp.
Video tutorial
This video covers following and more so watch carefully. After watching this video follow the steps described in this article.
- How to download SSIS PowerPack for Mailchimp integration in SSIS
- How to configure connection for Mailchimp
- How to write or lookup data to Mailchimp
- Features about SSIS API Destination
- Using Mailchimp Connector in SSIS
Step-by-step instructions
In upper section we learned how to read data, now in this section we will learn how to configure Mailchimp in the API Source to POST data to the Mailchimp.
-
Read the data from the source, being any desired source component. In example we will use ZappySys Dummy Data Source component.
-
From the SSIS Toolbox drag and drop API Destination (Predefined Templates) on the Data Flow Designer surface and connect source component with it, and double click to edit it.
-
Select New Connection to create a new connection:
API Destination - Mailchimp
Read / write MailChimp Campaigns, Lists, Members, Reports and more in without coding.
-
Use a preinstalled Mailchimp Connector from Popular Connector List or press Search Online radio button to download Mailchimp Connector. Once downloaded simply use it in the configuration:
Mailchimp
-
Proceed with selecting the desired Authentication Type. Then select API Base URL (in most cases default one is the right one). Finally, fill in all the required parameters and set optional parameters if needed. You may press a link Steps to Configure which will help set certain parameters. More info is available in Authentication section.
Steps how to get and use Mailchimp credentials
To get the credentials you need in order to set up your OAuth workflow, you'll first need to register your application with Mailchimp:
-
Login into your Mailchimp account, click on your Profile Icon, and hit Account & billing:
-
Navigate to the Registered Apps page in your Mailchimp account:
-
Click Register An App button:
-
Fill-in the Register An App form and click Create button:
NOTE:
For Redirect URI use Redirect URI (also called "Redirect URL" or "Callback URL") given by your IT administrator
or just use https://zappysys.com/oauth
, if you don't have one.
-
After successfully registering your application,
you'll see the Client ID and Client Secret,
record these values and store them securely:
-
Record your Mailchimp data center, since we will need it later.
The data center is located in your browser's address bar URL.
If the URL is
https://us21.admin.mailchimp.com/account/api
, then your data center is us21
.
-
Now go to SSIS package or ODBC data source OAuth authentication configuration.
-
Proceed by entering the data center into the Data Center field that was recorded in the previous step.
-
Then enter the Client ID value into the Client ID field that you recorded in the previous step.
-
Enter the Client Secret value into the Client Secret field that was recorded in the previous step.
-
Click Generate Token.
If proper authentication occurs, you will see a confirmation notice.
If you get an error, click Yes on the dialog box and then a large browser window will launch.
Then log into your Mailchimp account and approve the use of the application.
-
Finally, hit the Test Connection button at the bottom of the window to verify proper connectivity with your Mailchimp account.
-
If the connection test succeeds, select OK.
-
Done! Now you can use Mailchimp Connector!
Configuring authentication parameters
Mailchimp
OAuth [OAuth]
https://[$DataCenter$].api.mailchimp.com
Steps how to get and use Mailchimp credentials
The simplest way to authenticate a request to the Mailchimp Marketing API is by using an API key (If you require access to Mailchimp on behalf of other Mailchimp users, you'll want to set up OAuth authentication instead)::
-
Login into your Mailchimp account, click on your Profile Icon, and hit Account & billing:
-
Navigate to the API keys page in your Mailchimp account:
-
In the Your API keys section of the page, click Create A Key button:
-
Give your new key a descriptive name that will remind you which application it's used for:
-
Copy the API key immediately and store it in a secure location (you won't be able to see or copy the key once you finish generating it):
-
Record your Mailchimp data center, since we will need it later.
The data center is located in your browser's address bar URL.
If the URL is
https://us21.admin.mailchimp.com/account/api
, then your data center is us21
.
-
Now go to SSIS package or ODBC data source ApiKey Auth authentication configuration.
-
Proceed by entering the data center into the Data Center field that was recorded in the previous step.
-
Then enter the API key into the Api Key field that you copied earlier.
-
Finally, click the Test Connection button at the bottom of the window to verify proper connectivity with your Mailchimp account.
-
Done! Now you can use Mailchimp Connector!
Configuring authentication parameters
Mailchimp
ApiKey Auth [Http]
https://[$DataCenter$].api.mailchimp.com
-
Select the desired endpoint, change/pass the properties values, and go to the Mappings tab to map the columns.
API Destination - Mailchimp
Read / write MailChimp Campaigns, Lists, Members, Reports and more in without coding.
-
Finally, map the desired columns:
API Destination - Mailchimp
Read / write MailChimp Campaigns, Lists, Members, Reports and more in without coding.
-
That's it; we successfully configured the POST API Call. In a few clicks we configured the Mailchimp API call using ZappySys Mailchimp Connector
Load Mailchimp data into SQL Server using Upsert Destination (Insert or Update)
Once you configured the data source, you can load Mailchimp data into SQL Server using Upsert Destination.
Upsert Destination can merge or synchronize source data with the target table.
It supports Microsoft SQL Server, PostgreSQL, and Redshift databases as targets.
Upsert Destination also supports very fast bulk upsert
operation along with bulk delete
.
Upsert operation
- a database operation which performs INSERT
or UPDATE
SQL commands
based on record's existence condition in the target table.
It inserts records that don't have matching records in the target table
or updates them, if they do,
by matching them by key columns.
Upsert Destination supports INSERT
, UPDATE
, and DELETE
operations,
so it is similar to SQL Server's MERGE
command, except it can be used directly in SSIS package.
-
From the SSIS Toolbox drag-and-drop Upsert Destination component onto the Data Flow designer background.
-
Connect your SSIS source component to Upsert Destination.
-
Double-click on Upsert Destination component to open configuration window.
-
Start by selecting the Action from the list.
-
Next, select the desired target connection
or create one by clicking <New [provider] Connection> menu item from the Target Connection dropdown.
-
Then select a table from the Target Table list
or click New button to create a new table based on the source columns.
-
Continue by checking Insert and Update options according to your scenario
(e.g. if Update option is unchecked, no updates will be made).
-
Finally, click Map All button to map all columns
and then select the Key columns to match the columns on:
-
Click OK to save the configuration.
-
Run the package and Mailchimp data will be merged with the target table in SQL Server, PostgreSQL, or Redshift:
-
Done!
Deploy and schedule SSIS package
After you are done creating SSIS package, most likely, you want to deploy it to SQL Server Catalog and run it periodically.
Just follow the instructions in this article:
Running SSIS package in Azure Data Factory (ADF)
To use SSIS PowerPack in ADF, you must first prepare Azure-SSIS Integration Runtime.
Follow this link for detailed instructions:
Advanced topics
Actions supported by Mailchimp Connector
Mailchimp Connector support following actions for REST API integration.
If some actions are not listed below then you can easily edit Connector file and enhance out of the box functionality.
Gets details about the current Mailchimp user account. [
Read more...
]
Get all campaigns in an account. [
Read more...
]
Parameter |
Description |
Campaign type |
The campaign type. Possible values: regular, plaintext, absplit, rss, or variate.
Option |
Value |
regular |
regular |
plaintext |
plaintext |
absplit |
absplit |
rss |
rss |
variate |
variate |
|
Status of the campaign |
The status of the campaign. Possible values: save, paused, schedule, sending, or sent.
Option |
Value |
save |
save |
paused |
paused |
schedule |
schedule |
sending |
sending |
sent |
sent |
|
Campaign sent before (Format: 2015-10-21T15:41:36) |
Restrict the response to campaigns sent before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
Option |
Value |
today |
today |
yesterday |
yesterday |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
|
Campaign sent after (Format: 2015-10-21T15:41:36) |
Restrict the response to campaigns sent after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
Option |
Value |
today |
today |
yesterday |
yesterday |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
|
Campaign created before (Format: 2015-10-21T15:41:36) |
Restrict the response to campaigns created before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
Option |
Value |
today |
today |
yesterday |
yesterday |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
|
Campaign created after (Format: 2015-10-21T15:41:36) |
Restrict the response to campaigns created after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
Option |
Value |
today |
today |
yesterday |
yesterday |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
|
Using list Id |
The unique id for the list.
|
Using folder Id |
The unique folder id.
|
To customer |
Retrieve campaigns sent to a particular list member. Member ID is The MD5 hash of the lowercase version of the list member’s email address.
|
Get information about a specific campaign. [
Read more...
]
Parameter |
Description |
Campaign Id |
The ID of the campaign for which data should be read.
|
Create a new list in your Mailchimp account. [
Read more...
]
Get information about all lists in the account. [
Read more...
]
Parameter |
Description |
Created before (Format: 2015-10-21T15:41:36) |
Restrict response to lists created before the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
Option |
Value |
today |
today |
yesterday |
yesterday |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
|
Created after (Format: 2015-10-21T15:41:36) |
Restrict results to lists created after the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
Option |
Value |
today |
today |
yesterday |
yesterday |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
|
Created before last campaign send date (Format: 2015-10-21T15:41:36) |
Restrict results to lists created before the last campaign send date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
Option |
Value |
today |
today |
yesterday |
yesterday |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
|
Created after last campaign send date (Format: 2015-10-21T15:41:36) |
Restrict results to lists created after the last campaign send date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
Option |
Value |
today |
today |
yesterday |
yesterday |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
|
Includes email address |
Restrict results to lists that include a specific subscriber's email address.
|
Contains active ecommerce store |
Restrict results to lists that contain an active, connected, undeleted ecommerce store.
Option |
Value |
true |
true |
false |
false |
|
Get information about a specific campaign. [
Read more...
]
Parameter |
Description |
List Id |
The ID of the list for which data should be read.
|
Delete a specific list. [
Read more...
]
Parameter |
Description |
List Id |
The ID of the list which should be deleted.
|
Update the settings for a specific list. [
Read more...
]
Parameter |
Description |
List Id |
The ID of the list for which data should be updated.
|
Add a new member to the list. It throws error if same email exists [
Read more...
]
Parameter |
Description |
List Id |
The ID of the list for which you like to perform this operation.
|
Skip Merge Validation |
If skip_merge_validation is true, member data will be accepted without merge field values, even if the merge field is usually required. This defaults to false.
Option |
Value |
true |
true |
false |
false |
|
Add or Update Upsert List Members (Bulk Subscribe or Unsubscribe)
Add or Update Upsert List Members (Bulk Subscribe or Unsubscribe). [
Read more...
]
Parameter |
Description |
List Id |
The ID of the list for which you like to perform this operation.
|
Skip Merge Validation |
If skip_merge_validation is true, member data will be accepted without merge field values, even if the merge field is usually required. This defaults to false.
Option |
Value |
true |
true |
false |
false |
|
Skip Duplicate Check |
If skip_duplicate_check is true, we will ignore duplicates sent in the request when using the batch sub/unsub on the lists endpoint. The status of the first appearance in the request will be saved. This defaults to false.
Option |
Value |
true |
true |
false |
false |
|
Update Exising Subscription Status? |
Whether this batch operation will change existing members' subscription status.
Option |
Value |
true |
true |
false |
false |
|
Sync Tags |
Whether this batch operation will replace all existing tags with tags in request.
Option |
Value |
true |
true |
false |
false |
|
Add New List Members in Bulk
Adds multiple members using Bulk API. [
Read more...
]
Parameter |
Description |
List Id |
The ID of the list for which you like to perform this operation.
|
Skip Merge Validation |
If skip_merge_validation is true, member data will be accepted without merge field values, even if the merge field is usually required. This defaults to false.
Option |
Value |
true |
true |
false |
false |
|
Get information about members in a specific Mailchimp list. [
Read more...
]
Parameter |
Description |
List Id |
The ID of the list for which you like to perform this operation.
|
Email Type |
The email type.
Option |
Value |
html |
html |
text |
text |
|
Status |
The subscriber's status. Possible values: subscribed, unsubscribed, cleaned, pending, transactional, or archived.
Option |
Value |
subscribed |
subscribed |
unsubscribed |
unsubscribed |
cleaned |
cleaned |
pending |
pending |
transactional |
transactional |
archived |
archived |
|
Since Timestamp Opt (Format: 2015-10-21T15:41:36) |
Restrict results to subscribers who opted-in after the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
Option |
Value |
today |
today |
yesterday |
yesterday |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
|
Before Timestamp Opt (Format: 2015-10-21T15:41:36) |
Restrict results to subscribers who opted-in before the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
Option |
Value |
today |
today |
yesterday |
yesterday |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
|
Since Last Changed (Format: 2015-10-21T15:41:36) |
Restrict results to subscribers whose information changed after the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
Option |
Value |
today |
today |
yesterday |
yesterday |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
|
Before Last Changed (Format: 2015-10-21T15:41:36) |
Restrict results to subscribers whose information changed before the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
Option |
Value |
today |
today |
yesterday |
yesterday |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
|
Unique Email Id |
A unique identifier for the email address across all Mailchimp lists.
|
VIP Only |
A filter to return only the list's VIP members. Passing true will restrict results to VIP list members, passing false will return all list members.
Option |
Value |
true |
true |
false |
false |
|
Interest Category Id |
The unique id for the interest category.
|
Interest Ids |
Used to filter list members by interests. Must be accompanied by interest_category_id and interest_match. The value must be a comma separated list of interest ids present for any supplied interest categories.
|
Interest Match |
Used to filter list members by interests. Must be accompanied by interest_category_id and interest_ids. 'any' will match a member with any of the interest supplied, 'all' will only match members with every interest supplied, and 'none' will match members without any of the interest supplied. Possible values: 'any', 'all', or 'none'.
|
Since Last Campaign |
Filter subscribers by those subscribed/unsubscribed/pending/cleaned since last email campaign send. Member status is required to use this filter.
Option |
Value |
true |
true |
false |
false |
|
Unsubscribed Since (Format: 2015-10-21T15:41:36) |
Filter subscribers by those unsubscribed since a specific date. Using any status other than unsubscribed with this filter will result in an error.
Option |
Value |
today |
today |
yesterday |
yesterday |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
|
Get All Members in All Lists
Get information about all members in all lists. [
Read more...
]
Parameter |
Description |
Email Type |
The email type.
Option |
Value |
html |
html |
text |
text |
|
Status |
The subscriber's status. Possible values: subscribed, unsubscribed, cleaned, pending, transactional, or archived.
Option |
Value |
subscribed |
subscribed |
unsubscribed |
unsubscribed |
cleaned |
cleaned |
pending |
pending |
transactional |
transactional |
archived |
archived |
|
Since Timestamp Opt (Format: 2015-10-21T15:41:36) |
Restrict results to subscribers who opted-in after the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
Option |
Value |
today |
today |
yesterday |
yesterday |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
|
Before Timestamp Opt (Format: 2015-10-21T15:41:36) |
Restrict results to subscribers who opted-in before the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
Option |
Value |
today |
today |
yesterday |
yesterday |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
|
Since Last Changed (Format: 2015-10-21T15:41:36) |
Restrict results to subscribers whose information changed after the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
Option |
Value |
today |
today |
yesterday |
yesterday |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
|
Before Last Changed (Format: 2015-10-21T15:41:36) |
Restrict results to subscribers whose information changed before the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
Option |
Value |
today |
today |
yesterday |
yesterday |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
|
Unique Email Id |
A unique identifier for the email address across all Mailchimp lists.
|
VIP Only |
A filter to return only the list's VIP members. Passing true will restrict results to VIP list members, passing false will return all list members.
Option |
Value |
true |
true |
false |
false |
|
Interest Category Id |
The unique id for the interest category.
|
Interest Ids |
Used to filter list members by interests. Must be accompanied by interest_category_id and interest_match. The value must be a comma separated list of interest ids present for any supplied interest categories.
|
Interest Match |
Used to filter list members by interests. Must be accompanied by interest_category_id and interest_ids. 'any' will match a member with any of the interest supplied, 'all' will only match members with every interest supplied, and 'none' will match members without any of the interest supplied. Possible values: 'any', 'all', or 'none'.
|
Since Last Campaign |
Filter subscribers by those subscribed/unsubscribed/pending/cleaned since last email campaign send. Member status is required to use this filter.
Option |
Value |
true |
true |
false |
false |
|
Unsubscribed Since (Format: 2015-10-21T15:41:36) |
Filter subscribers by those unsubscribed since a specific date. Using any status other than unsubscribed with this filter will result in an error.
Option |
Value |
today |
today |
yesterday |
yesterday |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
|
Get a Specific Member From All Lists
Get information about all members in all lists. [
Read more...
]
Parameter |
Description |
Member Id |
The ID of the member for which to get details.
|
Get information about a specific list member, including a currently subscribed, unsubscribed, or bounced member. [
Read more...
]
Parameter |
Description |
List Id |
The ID of the list for which you like to perform this operation.
|
Member Id |
The ID of the list member for which data should be read.
|
Delete List Member (Archive)
Archive a list member. To permanently delete, use the delete_list_member_permanent endpoint. [
Read more...
]
Parameter |
Description |
List Id |
The ID of the list for which you like to perform this operation.
|
Member Id |
The ID of the list member for which data should be deleted.
|
Delete List Member (Permanent delete)
Delete all personally identifiable information related to a list member, and remove them from a list. This will make it impossible to re-import the list member. [
Read more...
]
Parameter |
Description |
List Id |
The ID of the list for which you like to perform this operation.
|
Member Id |
The ID of the list member for which data should be deleted.
|
Update List Member Details
Update the settings for a specific list member. [
Read more...
]
Parameter |
Description |
List Id |
The ID of the list for which you like to perform this operation.
|
Member Id |
The ID of the member to update.
|
Skip Merge Validation |
If skip_merge_validation is true, member data will be accepted without merge field values, even if the merge field is usually required. This defaults to false.
Option |
Value |
true |
true |
false |
false |
|
This is generic endpoint. Use this endpoint when some actions are not implemented by connector. Just enter partial URL (Required), Body, Method, Header etc. Most parameters are optional except URL. [
Read more...
]
Parameter |
Description |
Url |
API URL goes here. You can enter full URL or Partial URL relative to Base URL. If it is full URL then domain name must be part of ServiceURL or part of TrustedDomains
|
Body |
Request Body content goes here
|
IsMultiPart |
Set this option if you want to upload file(s) (i.e. POST RAW file data) or send data using Multi-Part encoding method (i.e. Content-Type: multipart/form-data). Multi-Part request allows you to mix key/value and upload files in same request. On the other hand raw upload allows only single file upload (without any key/value)
==== Raw Upload (Content-Type: application/octet-stream) =====
To upload single file in raw mode check this option and specify full file path starting with @ sign in the Body (e.g. @c:\data\myfile.zip )
==== Form-Data / Multipart Upload (Content-Type: multipart/form-data) =====
To treat your Request data as multi part fields you must specify key/value pairs separated by new lines into RequestData field (i.e. Body). Each key value pair is entered on new-line and key/value are separated using equal sign (=). Preceding and trailing spaces are ignored also blank lines are ignored.
If field value has some any special character(s) then use escape sequence (e.g. For NewLine: \r\n, For Tab: \t, For at (@): \@). When value of any field starts with at sign (@) its automatically treated as File you want to upload. By default file content type is determined based on extension however you can supply content type manually for any field using this way [ YourFileFieldName.Content-Type=some-content-type ]. By default File Upload Field always includes Content-Type in the request (non file fields do not have content-type by default unless you supply manually). For some reason if you dont want to use Content-Type header in your request then supply blank Content-Type to exclude this header altogather [e.g. SomeFieldName.Content-Type= ]. In below example we have supplied Content-Type for file2 and SomeField1, all other fields are using default content-type.
See below Example of uploading multiple files along with additional fields. If some API requires you to pass Content-Type: multipart/form-data rather than multipart/form-data then manually set Request Header => Content-Type: multipart/mixed (it must starts with multipart/ else will be ignored).
file1=@c:\data\Myfile1.txt
file2=@c:\data\Myfile2.json
file2.Content-Type=application/json
SomeField1=aaaaaaa
SomeField1.Content-Type=text/plain
SomeField2=12345
SomeFieldWithNewLineAndTab=This is line1\r\nThis is line2\r\nThis is \ttab \ttab \ttab
SomeFieldStartingWithAtSign=\@MyTwitterHandle
|
Filter |
Enter filter to extract array from response. Example: $.rows[*] --OR-- $.customers[*].orders[*]. Check your response document and find out hierarchy you like to extract
Option |
Value |
No filter |
|
Example1 |
$.store.books[*] |
Example2 (Sections Under Books) |
$.store.books[*].sections[*] |
Example3 (Equals) |
$.store.books[?(@author=='sam')] |
Example4 (Equals - Any Section) |
$..[?(@author=='sam')] |
Example5 (Not Equals - Any Section) |
$..[?(@author!='sam')] |
Example6 (Number less than) |
$.store.books[?(@.price<10)]
Example7 (Regular Expression - Contains Pattern)=$.store.books[?(@author=~ /sam|bob/ )] |
Example8 (Regular Expression - Does Not Contain Pattern) |
$.store.books[?(@author=~ /^((?!sam|bob).)*$/ )] |
Example9 (Regular Expression - Exact Pattern Match) |
$.store.books[?(@author=~ /^sam|bob$/ )] |
Example10 (Regular Expression - Starts With) |
$.store.books[?(@author=~ /^sam/ )] |
Example11 (Regular Expression - Ends With) |
$.store.books[?(@author=~ /sam$/ )] |
Example12 (Between) |
$.store.employees[?( @.hiredate>'2015-01-01' && @.hiredate<'2015-01-04' )] |
|
Headers |
Headers for Request. To enter multiple headers use double pipe or new line after each {header-name}:{value} pair
|
Generic Request (Bulk Write)
This is a generic endpoint for bulk write purpose. Use this endpoint when some actions are not implemented by connector. Just enter partial URL (Required), Body, Method, Header etc. Most parameters are optional except URL. [
Read more...
]
Parameter |
Description |
Url |
API URL goes here. You can enter full URL or Partial URL relative to Base URL. If it is full URL then domain name must be part of ServiceURL or part of TrustedDomains
|
IsMultiPart |
Set this option if you want to upload file(s) (i.e. POST RAW file data) or send data using Multi-Part encoding method (i.e. Content-Type: multipart/form-data). Multi-Part request allows you to mix key/value and upload files in same request. On the other hand raw upload allows only single file upload (without any key/value)
==== Raw Upload (Content-Type: application/octet-stream) =====
To upload single file in raw mode check this option and specify full file path starting with @ sign in the Body (e.g. @c:\data\myfile.zip )
==== Form-Data / Multipart Upload (Content-Type: multipart/form-data) =====
To treat your Request data as multi part fields you must specify key/value pairs separated by new lines into RequestData field (i.e. Body). Each key value pair is entered on new-line and key/value are separated using equal sign (=). Preceding and trailing spaces are ignored also blank lines are ignored.
If field value has some any special character(s) then use escape sequence (e.g. For NewLine: \r\n, For Tab: \t, For at (@): \@). When value of any field starts with at sign (@) its automatically treated as File you want to upload. By default file content type is determined based on extension however you can supply content type manually for any field using this way [ YourFileFieldName.Content-Type=some-content-type ]. By default File Upload Field always includes Content-Type in the request (non file fields do not have content-type by default unless you supply manually). For some reason if you dont want to use Content-Type header in your request then supply blank Content-Type to exclude this header altogather [e.g. SomeFieldName.Content-Type= ]. In below example we have supplied Content-Type for file2 and SomeField1, all other fields are using default content-type.
See below Example of uploading multiple files along with additional fields. If some API requires you to pass Content-Type: multipart/form-data rather than multipart/form-data then manually set Request Header => Content-Type: multipart/mixed (it must starts with multipart/ else will be ignored).
file1=@c:\data\Myfile1.txt
file2=@c:\data\Myfile2.json
file2.Content-Type=application/json
SomeField1=aaaaaaa
SomeField1.Content-Type=text/plain
SomeField2=12345
SomeFieldWithNewLineAndTab=This is line1\r\nThis is line2\r\nThis is \ttab \ttab \ttab
SomeFieldStartingWithAtSign=\@MyTwitterHandle
|
Filter |
Enter filter to extract array from response. Example: $.rows[*] --OR-- $.customers[*].orders[*]. Check your response document and find out hierarchy you like to extract
|
Headers |
Headers for Request. To enter multiple headers use double pipe (||) or new line after each {header-name}:{value} pair
|
Conclusion
In this article we showed you how to connect to Mailchimp in SSIS and integrate data without any coding, saving you time and effort.
We encourage you to download Mailchimp Connector for SSIS and see how easy it is to use it for yourself or your team.
If you have any questions, feel free to contact ZappySys support team.
You can also open a live chat immediately by clicking on the chat icon below.
Download Mailchimp Connector for SSIS
Documentation
More integrations
Other connectors for SSIS
Other application integration scenarios for Mailchimp
Common Searches:
How to connect Mailchimp in SSIS?
How to get Mailchimp data in SSIS?
How to read Mailchimp data in SSIS?
How to load Mailchimp data in SSIS?
How to import Mailchimp data in SSIS?
How to pull Mailchimp data in SSIS?
How to push data to Mailchimp in SSIS?
How to write data to Mailchimp in SSIS?
How to POST data to Mailchimp in SSIS?
Call Mailchimp API in SSIS
Consume Mailchimp API in SSIS
Mailchimp SSIS Automate
Mailchimp SSIS Integration
Integration Mailchimp in SSIS
Consume real-time Mailchimp data in SSIS
Consume real-time Mailchimp API data in SSIS
Mailchimp ODBC Driver | ODBC Driver for Mailchimp | ODBC Mailchimp Driver | SSIS Mailchimp Source | SSIS Mailchimp Destination
Connect Mailchimp in SSIS
Load Mailchimp in SSIS
Load Mailchimp data in SSIS
Read Mailchimp data in SSIS
Mailchimp API Call in SSIS