Mailchimp Connector for JAVA In this article you will learn how to integrate Mailchimp data in JAVA (live / bi-directional connection to Mailchimp). Read / write MailChimp Campaigns, Lists, Members, Reports and more in without coding.. Using Mailchimp Connector you will be able to connect, read, and write data from within JAVA. Follow the steps below to see how we would accomplish that. Download Documentation The driver mentioned above is part of ODBC PowerPack which is a collection of high-performance Drivers for various API data source (i.e. REST API, JSON, XML, CSV, Amazon S3 and many more). Using familiar SQL query language you can make live connections and read/write data from API sources or JSON / XML / CSV Files inside SQL Server (T-SQL) or your favorite Reporting (i.e. Power BI, Tableau, Qlik, SSRS, MicroStrategy, Excel, MS Access), ETL Tools (i.e. Informatica, Talend, Pentaho, SSIS). You can also call our drivers from programming languages such as JAVA, C#, Python, PowerShell etc. If you are new to ODBC and ZappySys ODBC PowerPack then check the following links to get started. ODBC PowerPack - System Requirements and Installation Getting Started - Using ODBC PowerPack ODBC API Driver Help File

Connect to Mailchimp in other apps Connect to Mailchimp in SSIS Connect to Mailchimp in SQL Server Connect to Mailchimp in Power BI Connect to Mailchimp in SSRS Connect to Mailchimp in Informatica Connect to Mailchimp in MS Access Connect to Mailchimp in MS Excel Connect to Mailchimp in SSAS Connect to Mailchimp in C# Connect to Mailchimp in Python Connect to Mailchimp in Tableau Connect to Mailchimp in SAP Crystal Reports Connect to Mailchimp in Azure Data Factory (Pipeline) Connect to Mailchimp in Azure Data Factory (SSIS) Connect to Mailchimp in Talend Studio Connect to Mailchimp in UiPath Connect to Mailchimp in PowerShell Connect to Mailchimp in ODBC

Create Data Source in ZappySys Data Gateway based on API Driver

1. Download and install ZappySys ODBC PowerPack.

2. Search for gateway in start menu and Open ZappySys Data Gateway:
   

3. Go to Users Tab to add our first Gateway user. Click Add; we will give it a name tdsuser and enter password you like to give. Check Admin option and click OK to save. We will use these details later when we create linked server:
   

4. Now we are ready to add a data source. Click Add, give data source a name (Copy this name somewhere, we will need it later) and then select Native - ZappySys API Driver. Finally, click OK. And it will create the Data Set for it and open the ZS driver UI.

   MailchimpDSN

   
   

5. When the Configuration window appears give your data source a name if you haven't done that already, then select "Mailchimp" from the list of Popular Connectors. If "Mailchimp" is not present in the list, then click "Search Online" and download it. Then set the path to the location where you downloaded it. Finally, click Continue >> to proceed with configuring the DSN:

   MailchimpDSN

   Mailchimp

   

6. Now it's time to configure the Connection Manager. Select Authentication Type, e.g. Token Authentication. Then select API Base URL (in most cases, the default one is the right one). More info is available in the Authentication section.

    OAuth [OAuth]

   Steps to get 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:

   1. Navigate to the Registered Apps page in your Mailchimp account.
   2. Click Register An App.
   3. Fill out the Register An App form.
   4. Click Create.
   5. After successfully registering your application, you'll see the client_id and client_secret at the bottom of the page - record these values and store them securely.
   6. Record your Mailchimp data center, since we will need it later. The data center will be 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".
   7. Back at the connector screen, enter the data center that was recorded in step 6 into the Data Center field.
   8. Enter the client_id value that was recorded in step 5 into the Client Id field.
   9. Enter the client_secret value that was recorded in step 5 into the Client Secret field.
   10. Click Generate Token. If proper authentication occurs, you will see a notice saying so. If you get any errors, click Yes on the dialog box and then a large browser window will launch - log into your Mailchimp account here and approve the use of the application.
   11. Select the Test Connection button at the bottom of the window to verify proper connectivity with your Mailchimp account.
   12. If the connection test succeeds, select OK.

   Fill in all required parameters and set optional parameters if needed:

   MailchimpDSN

   Mailchimp

   OAuth [OAuth]

   https://[$DataCenter$].api.mailchimp.com

   Required Parameters
   Data Center	Fill in the parameter...
   Client Id	Fill in the parameter...
   Client Secret	Fill in the parameter...
   Default List Id	Fill in the parameter...
   Optional Parameters
   RetryMode	Fill in the parameter...
   RetryStatusCodeList	Fill in the parameter...
   RetryCountMax	Fill in the parameter...
   RetryMultiplyWaitTime	Fill in the parameter...

   

    ApiKey Auth [Http]

   Steps to get 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)::

   1. Log into your Mailchimp account.
   2. Navigate to the API Keys section of your Mailchimp account: https://admin.mailchimp.com/account/api/
   3. In the Your API keys section of the page, click Create New Key.
   4. Give your new key a descriptive name that will remind you which application it's used for.
   5. Copy the generated 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.)
   6. Record your Mailchimp data center, since we will need it later. The data center will be 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".
   7. Back at the connector screen, enter the data center that was recorded in step 6 into the Data Center field.
   8. Enter the API key that was recorded in step 5 into the Api Key field.
   9. Select the Test Connection button at the bottom of the window to verify proper connectivity with your Mailchimp account.
   10. If the connection test succeeds, select OK.

   Fill in all required parameters and set optional parameters if needed:

   MailchimpDSN

   Mailchimp

   ApiKey Auth [Http]

   https://[$DataCenter$].api.mailchimp.com

   Required Parameters
   Api Key	Fill in the parameter...
   Default List Id	Fill in the parameter...
   Optional Parameters
   Data Center	Fill in the parameter...
   RetryMode	Fill in the parameter...
   RetryStatusCodeList	Fill in the parameter...
   RetryCountMax	Fill in the parameter...
   RetryMultiplyWaitTime	Fill in the parameter...

   

7. Once the data source has been configured, you can preview data. Select the Preview tab and use settings similar to the following to preview data:
   

8. Click OK to finish creating the data source.

Read data in Java from the DSN

1. Java code to get the data:
   

   "jdbc:sqlserver://localhost:5000;databasename=MailchimpDSN;user=tdsuser;password=test"

   

2. When you run the code it will make the API call and read the data:
   

3. Here is Java program's code in text format:

   
   //Step-1: Install ZappySys ODBC PowerPack and Configure Data Gateway
   
   //Step-2:Assuming the Microsoft SQL Server JDBC Driver is in below folder
   //C:\Program Files\Microsoft Jdbc Driver 6.0 for SQL Server\sqljdbc_6.0\enu\auth\x64
   package padaone;
   
   import java.sql.*;
   
   public class zappy {
   
       public static void main(String[] args) {
   
           // Create a variable for the connection string.
           String connectionUrl = "jdbc:sqlserver://localhost:5000;databasename=MailchimpDSN;user=test;password=test";
   
           // Declare the JDBC objects.
           Connection con = null;
           Statement stmt = null;
           ResultSet rs = null;
   
               try {
                   // Establish the connection.
                   Class.forName("com.microsoft.sqlserver.jdbc.SQLServerDriver");
                   con = DriverManager.getConnection(connectionUrl);
   
                   // Create and execute an SQL statement that returns some data.
                   String SQL = "SELECT Country , SUM(UnitPrice * Quantity) Total " 
                              + "FROM value " 
                              + "GROUP BY Country "
                              + "WITH (SRC='https://services.odata.org/V3/Northwind/Northwind.svc/Invoices?$format=json')";
                   stmt = con.createStatement();
                   rs = stmt.executeQuery(SQL);
   
                   // Iterate through the data in the result set and display it.
                   while (rs.next()) {
                       System.out.println(rs.getString(1) + " " + rs.getString(2));
                   }
               }
   
           // Handle any errors that may have occurred.
           catch (Exception e) {
               e.printStackTrace();
           } 
           
           finally {
               if (rs != null) try { rs.close(); } catch (Exception e) {}
               if (stmt != null) try { stmt.close(); } catch (Exception e) {}
               if (con != null) try { con.close(); } catch (Exception e) {}
           }
       }
   }

Advanced topics

Create Custom Stored Procedure in ZappySys Driver

You can create procedures to encapsulate custom logic and then only pass handful parameters rather than long SQL to execute your API call.

Steps to create Custom Stored Procedure in ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here

1. Go to Custom Objects Tab and Click on Add button and Select Add Procedure:
   

2. Enter the desired Procedure name and click on OK:
   

3. Select the created Stored Procedure and write the your desired stored procedure and Save it and it will create the custom stored procedure in the ZappySys Driver:
   Here is an example stored procedure for ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here
   

   CREATE PROCEDURE [usp_get_orders]
       @fromdate = '<<yyyy-MM-dd,FUN_TODAY>>'
    AS
       SELECT * FROM Orders where OrderDate >= '<@fromdate>';
   

   
   

4. That's it now go to Preview Tab and Execute your Stored Procedure using Exec Command. In this example it will extract the orders from the date 1996-01-01:
   

   Exec usp_get_orders '1996-01-01';

   
   

5. Let's generate the SQL Server Query Code to make the API call using stored procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
   As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder.
   

   SELECT * FROM OPENQUERY([MY_API_SERVICE], 'EXEC usp_get_orders @fromdate=''1996-07-30''')

   
   

6. Now go to SQL served and execute that query and it will make the API call using stored procedure and provide you the response.
   

Create Custom Virtual Table in ZappySys Driver

ZappySys API Drivers support flexible Query language so you can override Default Properties you configured on Data Source such as URL, Body. This way you don't have to create multiple Data Sources if you like to read data from multiple EndPoints. However not every application support supplying custom SQL to driver so you can only select Table from list returned from driver.

If you're dealing with Microsoft Access and need to import data from an SQL query, it's important to note that Access doesn't allow direct import of SQL queries. Instead, you can create custom objects (Virtual Tables) to handle the import process.

Many applications like MS Access, Informatica Designer wont give you option to specify custom SQL when you import Objects. In such case Virtual Table is very useful. You can create many Virtual Tables on the same Data Source (e.g. If you have 50 URLs with slight variations you can create virtual tables with just URL as Parameter setting.

1. Go to Custom Objects Tab and Click on Add button and Select Add Table:
   

2. Enter the desired Table name and click on OK:
   

3. And it will open the New Query Window Click on Cancel to close that window and go to Custom Objects Tab.

4. Select the created table, Select Text Type AS SQL and write the your desired SQL Query and Save it and it will create the custom table in the ZappySys Driver:
   Here is an example SQL query for ZappySys Driver. You can insert Placeholders also. Read more about placeholders here
   

   SELECT
     "ShipCountry",
     "OrderID",
     "CustomerID",
     "EmployeeID",
     "OrderDate",
     "RequiredDate",
     "ShippedDate",
     "ShipVia",
     "Freight",
     "ShipName",
     "ShipAddress",
     "ShipCity",
     "ShipRegion",
     "ShipPostalCode"
   FROM "Orders"
   Where "ShipCountry"='USA'

   
   

5. That's it now go to Preview Tab and Execute your custom virtual table query. In this example it will extract the orders for the USA Shipping Country only:
   

   SELECT * FROM "vt__usa_orders_only"

   
   

6. Let's generate the SQL Server Query Code to make the API call using stored procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
   As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder.
   

   SELECT * FROM OPENQUERY([MY_API_SERVICE], 'EXEC [usp_get_orders] ''1996-01-01''')

   
   

7. Now go to SQL served and execute that query and it will make the API call using stored procedure and provide you the response.
   

Actions supported by Mailchimp Connector

Mailchimp Connector Examples for JAVA Connection

This page offers a collection of SQL examples designed for seamless integration with the ZappySys API ODBC Driver under ODBC Data Source (36/64) or ZappySys Data Gateway, enhancing your ability to connect and interact with Prebuilt Connectors effectively.

SELECT * FROM Campaigns

SELECT Id, WebId, Type, CreateTime, ArchiveUrl, LongArchiveUrl, Status, EmailsSent, SendTime, ContentType, NeedsBlockRefresh, Resendable, RecipientsListId, RecipientsListIsActive, RecipientsListName, RecipientsSegmentText, RecipientsRecipientCount, SettingsSubjectLine, SettingsTitle, SettingsFromName, SettingsReplyTo, SettingsUseConversation, SettingsToName, SettingsFolderId, SettingsAuthenticate, SettingsAutoFooter, SettingsInlineCss, SettingsAutoTweet, SettingsFbComments, SettingsTimeWarp, SettingsTemplateId, SettingsDragAndDrop, TrackingOpens, TrackingHtmlClicks, TrackingTextClicks, TrackingGoalTracking, TrackingEcomm360, TrackingGoogleAnalytics, TrackingClicktale, DeliveryStatusEnabled 
FROM Campaigns

SELECT * FROM Campaigns 
WHERE Id='328e99cbc4'

SELECT * FROM Lists

SELECT Id, WebId, Name, Company, Address1, Address2, City, State, Zip, Country, Phone, PermissionReminder, UseArchiveBar, CampaignDefaultFromName, CampaignDefaultFromEmail, CampaignDefaultSubject, CampaignDefaultLanguage, NotifyOnSubscribe, NotifyOnUnsubscribe, DateCreated, ListRating, EmailTypeOption, SubscribeUrlShort, SubscribeUrlLong, BeamerAddress, Visibility, DoubleOptin, HasWelcome, MarketingPermissions, Modules, MemberCount, UnsubscribeCount, CleanedCount, MemberCountSinceSend, UnsubscribeCountSinceSend, CleanedCountSinceSend, CampaignCount, CampaignLastSent, MergeFieldCount, AvgSubRate, AvgUnsubRate, TargetSubRate, OpenRate, ClickRate, LastSubDate, LastUnsubDate 
FROM Lists

SELECT * FROM Lists 
WHERE Id='e246f7e24d'

DELETE FROM Lists 
WHERE Id='e246f7e24d'

SELECT * FROM get_list_members 
WITH (ListId='e246f7e24d')

SELECT * FROM get_user_details

SELECT AccountId, LoginId, AccountName, Email, FirstName, LastName, UserName, AvatarUrl, Role, MemberSince, PricingPlanType, FirstPayment, AccountTimeZone, AccountIndustry, ContactCompany, ContactAddress1, ContactAddress2, ContactCity, ContactState, ContactZip, ContactCountry, ProEnabled, LastLogin, TotalSubscribers 
FROM get_user_details

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')

UPDATE Lists SET Address1='123 Main Street', Address2 = 'Suite 52',  City = 'Chicago'
WHERE Id='e246f7e24d'

SELECT * FROM ListMembers 
WHERE Id='170a0722daae03855d6434eb3a5959fb' 
WITH (ListId='e246f7e24d')

SELECT * FROM ListMembers 
WITH (ListId='e246f7e24d', Id='test@abc.com')

DELETE FROM ListMembers 
WHERE Id='170a0722daae03855d6434eb3a5959fb' 
WITH (ListId='e246f7e24d')

DELETTE from ListMembers 
WHERE TimestampOpt > '2023-06-16' 
WITH (ListId='a4d24015f8')

select * from delete_list_member_permanent 
WITH (ListId='a4d24015f8' , Id='170a0722daae03855d6434eb3a5959fb' )

SELECT * FROM ListMembers --scan all lists and then fetch members for each list

SELECT * FROM ListMembers 
WHERE Id='170a0722daae03855d6434eb3a5959fb'

SELECT Id, ListId, EmailAddress, UniqueEmailId, ContactId, FullName, WebId, EmailType, Status, ConsentsToOneToOneMessaging, FirstName, LastName, AddressLine1, AddressLine2, City, State, Zip, Country, Phone, Birthday, StatsAvgOpenRate, StatsAvgClickRate, IpSignup, TimestampSignup, IpOpt, TimestampOpt, MemberRating, LastChanged, Language, Vip, EmailClient, Latitude, Longitude, LocationGmtOff, LocationDstOff, CountryCode, TimeZone, Region, Source, TagsCount, Tags 
FROM ListMembers 
WITH (ListId='e246f7e24d')

INSERT INTO ListMembers
(EmailAddress, Status, EmailType, MergeFields, Language, Vip, Latitude, Longitude, IpSignup, TimestampSignup, IpOpt, TimestampOpt, Tags)
VALUES
('np-brucewayne1@zappysys.com', 'subscribed', 'html',
'{"FNAME":"John","LNAME":"Doe","ADDRESS":{"addr1":"123","Freddie":"Ave","city":"Atlanta","state":"GA","zip":"12345"}}',
'en', false, '41.881832', '-87.623177', '192.168.0.8', '2023-04-01 18:00:00', '192.168.0.8', '2023-04-02 14:00:00',
'["Newtag1","Newtag2","Newtag3"]')
WITH (ListId='a4d24015f8')

UPDATE ListMembers 
SET EmailAddress='brucewayne10@mycompany.com'
, Status='subscribed' --subscribed, unsubscribed, cleaned, pending
, EmailType='text' --html, text
, Vip='false' --true
, FirstName='Bruce'
, LastName='Wayne'
/*,MergeFields= '{
        "FNAME": "Bruce1",
        "LNAME": "Wayne1",
        "PHONE": "678-111-1234"
    }',
*/
, Language='en' --fr
, TimestampOpt='2023-04-02 11:37:49' 
, Latitude='38.8951' , Longitude='-77.0364' --Washington DC
, Tags='["tag1","tag2"]'
WHERE Id='e9f73ced3b649f0ca829103bcacb2846' 
WITH (ListId='a4d24015f8',SkipMergeValidation='false')

UPSERT INTO ListMembers
SOURCE('MSSQL', 'Data Source=localhost;Initial Catalog=tempdb;Integrated Security=true'
,'select ''brucewayne10@gmail.com'' EmailAddress,''first1'' as FirstName, ''subscribed'' Status 
UNION ALL
select ''test55@gmail.com'' EmailAddress,''first1'' FirstName, ''subscribed'' Status 
')
WITH(ListId='a4d24015f8')

 --//column name alias must match with InputColumns of ListMembers

UPSERT INTO ListMembers
SOURCE('ODBC', 'Driver={ZappySys CSV Driver};DataPath=c:\subscribers.csv'
,'select col1 as EmailAddress,col2 as FirstName, col3 as Status from $') --//column name alias must match with InputColumns of ListMembers
WITH(ListId='a4d24015f8')

UPSERT INTO ListMembers
SOURCE('ODBC', 'DSN=MyOdbcDsn
,'select col1 as EmailAddress,col2 as FirstName, col3 as Status from sometable') --//column name alias must match with InputColumns of ListMembers
WITH(ListId='a4d24015f8')

INSERT INTO ListMembersBulk
SOURCE('ODBC', 'DSN=MyOdbcDsn
,'select col1 as EmailAddress,col2 as FirstName, col3 as Status') --//column name alias must match with InputColumns of ListMembers
WITH(ListId='a4d24015f8')

Conclusion

In this article we discussed how to connect to Mailchimp in JAVA and integrate data without any coding. Click here to Download Mailchimp Connector for JAVA and try yourself see how easy it is. If you still have any question(s) then ask here or simply click on live chat icon below and ask our expert (see bottom-right corner of this page).

Download Mailchimp Connector for JAVA Documentation 

More integrations

Other application integration scenarios for Mailchimp

SSIS

SQL Server

Power BI

SSRS

Informatica

MS Access

MS Excel

SSAS

C#

Python

Tableau

SAP Crystal Reports

Azure Data Factory (Pipeline)

Azure Data Factory (SSIS)

Talend Studio

UiPath

PowerShell

ODBC

Other connectors for JAVA

Amazon Ads

Amazon MWS

Amazon Selling Partner (SP-API)

Asana

Azure DevOps

Cosmos DB

DropBox

ElasticSearch

FastSpring

Google BigQuery

Google Calendar

Google Drive

Google Sheets

Hubspot

Jira

Mailchimp

ManagedEngine ServiceDesk Plus (Zoho)

Nativo

OData

OneDrive

Outlook Mail (Office 365)

Power BI

ServiceNow

SharePoint Online

Shopify

Smartsheet

Stripe

YouTube

Zendesk

Zoho CRM

Zoho SalesIQ

Zoom

REST API

JSON

JSON File

XML

SOAP

XML File

JDBC-ODBC Bridge

Salesforce

CSV

Amazon S3 JSON File

Amazon S3 XML File

Amazon S3 CSV File

Azure Blob JSON File

Azure Blob XML File

Azure Blob CSV File

FTP/SFTP JSON File

FTP/SFTP XML File

FTP/SFTP CSV File

Build your own Custom API Connector

Download Mailchimp Connector for JAVA Documentation

Common Searches: