Skip to Content

Mailchimp Connection Details

Introduction

Connector Version

This documentation is based on version 25.0.9368 of the connector.

Get Started

Mailchimp Version Support

The connector defaults to version 3 of the Core Mailchimp API.

Establish a Connection

Connect to Mailchimp

Mailchimp supports the following authentication methods:

  • APIKey
  • OAuth
API Key

The easiest way to connect to Mailchimp is to use the API Key. The APIKey grants full access to your Mailchimp account. To obtain the APIKey:

  1. Log into Mailchimp.
  2. Navigate to Account > Extras > API Keys.
  3. Note the value of the API Key.

Once you have the value of the API Key:

  1. Set APIKey to the value of the API Key.
  2. Set AuthScheme to APIKey.
OAuth
Desktop Applications

To authenticate with the credentials for a custom OAuth application, you must get and refresh the OAuth access token. After you do that, you are ready to connect.

Get and refresh the OAuth access token:

When you connect, the connector opens Mailchimp's OAuth endpoint in your default browser. Log in and grant permissions to the application.

After you grant permissions to the application, the connector then completes the OAuth process:

  1. The connector obtains an access token from Mailchimp and uses it to request data.
  2. The OAuth values are saved in the path specified in OAuthSettingsLocation. These values persist across connections.

When the access token expires, the connector refreshes the access token automatically.

Create a Custom OAuth Application

Create a Custom OAuth Application

There are two authentication methods available for connecting to Mailchimp: You can use the APIKey or use OAuth.

OAuth can be used to enable other users to access their own data. It is also useful if you want to:

  • control branding of the authentication dialog;
  • control the redirect URI that the application redirects the user to after the user authenticates; or
  • customize the permissions that you are requesting from the user.

To register a custom OAuth application in Mailchimp and obtain the OAuth client credentials, the OAuthClientId and OAuthClientSecret:

  1. Log into your Mailchimp account.

  2. Navigate to Account > Extras > API Keys > Register and Manage Your Apps.

  3. Enter the information you want to be displayed to users when they are prompted to grant permissions to your application. This information includes your app name, company, and website.

  4. If this is a Desktop application, specify a Redirect URI of http://127.0.0.1.

    If this is a Web application, specify a Redirect URI where you would like users to be redirected after they grant permissions to your application.

After you have created and registered a custom OAuth app, users can connect to Mailchimp as described in "Connecting to Mailchimp".

Important Notes

Configuration Files and Their Paths

  • All references to adding configuration files and their paths refer to files and locations on the Jitterbit agent where the connector is installed. These paths are to be adjusted as appropriate depending on the agent and the operating system. If multiple agents are used in an agent group, identical files will be required on each agent.

Advanced Features

This section details a selection of advanced features of the Mailchimp connector.

User Defined Views

The connector supports the use of user defined views, virtual tables whose contents are decided by a pre-configured user defined query. These views are useful when you cannot directly control queries being issued to the drivers. For an overview of creating and configuring custom views, see User Defined Views.

SSL Configuration

Use SSL Configuration to adjust how connector handles TLS/SSL certificate negotiations. You can choose from various certificate formats. For further information, see the SSLServerCert property under "Connection String Options".

Proxy

To configure the connector using private agent proxy settings, select the Use Proxy Settings checkbox on the connection configuration screen.

Query Processing

The connector offloads as much of the SELECT statement processing as possible to Mailchimp and then processes the rest of the query in memory (client-side).

For further information, see Query Processing.

Log

For an overview of configuration settings that can be used to refine logging, see Logging. Only two connection properties are required for basic logging, but there are numerous features that support more refined logging, which enables you to use the LogModules connection property to specify subsets of information to be logged.

User Defined Views

The Mailchimp connector supports the use of user defined views: user-defined virtual tables whose contents are decided by a preconfigured query. User defined views are useful in situations where you cannot directly control the query being issued to the driver; for example, when using the driver from Jitterbit.

Use a user defined view to define predicates that are always applied. If you specify additional predicates in the query to the view, they are combined with the query already defined as part of the view.

There are two ways to create user defined views:

  • Create a JSON-formatted configuration file defining the views you want.
  • DDL statements.

Define Views Using a Configuration File

User defined views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The connector automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the connector.

This user defined view configuration file is formatted so that each root element defines the name of a view, and includes a child element, called query, which contains the custom SQL query for the view.

For example:

{
    "MyView": {
        "query": "SELECT * FROM Lists WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"

Define Views Using DDL Statements

The connector is also capable of creating and altering the schema via DDL Statements such as CREATE LOCAL VIEW, ALTER LOCAL VIEW, and DROP LOCAL VIEW.

Create a View

To create a new view using DDL statements, provide the view name and query as follows:

CREATE LOCAL VIEW [MyViewName] AS SELECT * FROM Customers LIMIT 20;

If no JSON file exists, the above code creates one. The view is then created in the JSON configuration file and is now discoverable. The JSON file location is specified by the UserDefinedViews connection property.

Alter a View

To alter an existing view, provide the name of an existing view alongside the new query you would like to use instead:

ALTER LOCAL VIEW [MyViewName] AS SELECT * FROM Customers WHERE TimeModified > '3/1/2020';

The view is then updated in the JSON configuration file.

Drop a View

To drop an existing view, provide the name of an existing schema alongside the new query you would like to use instead.

DROP LOCAL VIEW [MyViewName]

This removes the view from the JSON configuration file. It can no longer be queried.

Schema for User Defined Views

In order to avoid a view's name clashing with an actual entity in the data model, user defined views are exposed in the UserViews schema by default. To change the name of the schema used for UserViews, reset the UserViewsSchemaName property.

Work with User Defined Views

For example, a SQL statement with a user defined view called UserViews.RCustomers only lists customers in Raleigh:

SELECT * FROM Customers WHERE City = 'Raleigh';

An example of a query to the driver:

SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';

Resulting in the effective query to the source:

SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';

That is a very simple example of a query to a user defined view that is effectively a combination of the view query and the view definition. It is possible to compose these queries in much more complex patterns. All SQL operations are allowed in both queries and are combined when appropriate.

SSL Configuration

Customize the SSL Configuration

By default, the connector attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.

To specify another certificate, see the SSLServerCert connection property.

Data Model

The Data Model has three parts: Tables, Views, and Stored Procedures. The connector uses the Mailchimp API to process supported filters. The connector processes other filters client-side within the connector.

Tables

The Mailchimp connector models the Mailchimp API in Tables so that it can be easily queried and updated.

The connector dynamically retrieves custom fields for the ListMembers tables when you connect; any changes you make to these custom fields, such as adding a new field or changing a custom field's data type, are reflected when you reconnect.

Dynamic tables

Along with the default static tables, the connector also allows querying on dynamic tables. These are tables that are created based on the "audiences" (also called "lists") in your Mailchimp account.
For example, suppose you have these 3 audiences in your account: Old Audience, New Audience, VIP Audience. For each of these audiences the connector creates 2 new tables: One starting with "ListMembers_" and the other with "ListMergeFields_". So, for the case in hand, these 6 tables will be created:

  • ListMembers_OldAudience
  • ListMembers_NewAudience
  • ListMembers_VIPAudience
  • ListMergeFields_OldAudience
  • ListMergeFields_NewAudience
  • ListMergeFields_VIPAudience

The above 6 tables are created by removing spaces from the audience's name and appending the result to "ListMembers" or "ListMergeFields" with an underscore.

Tables starting with "ListMembers_" display all members for a specific audience along with custom fields' values.
The ones starting with "ListMergeFields_" display all custom fields' names for members in that audience.

Views

Views are tables that cannot be modified. Typically, data that are read-only and cannot be updated are shown as views.

Dynamic views

Along with the default static views, the connector also allows querying on dynamic views. These are views that are created based on the "audiences" (also called "lists") in your Mailchimp account.
For example, suppose you have these 3 audiences in your account: Old Audience, New Audience, VIP Audience. The connector lists 3 views based on them: ListMemberTags_OldAudience, ListMemberTags_NewAudience, ListMemberTags_VIPAudience.
The above 3 views are created by removing spaces from the audience's name and appending the result to "ListMemberTags" with an underscore. They return the tags that are assigned to each member of the audience you've specified.

Stored Procedures

Stored Procedures are function-like interfaces to the data source. They can be used to search, update, and modify information in the data source.

Tables

The connector models the data in Mailchimp as a list of tables in a relational database that can be queried using standard SQL statements.

Mailchimp Connector Tables

Name Description
CampaignFeedback A summary of the comment feedback for a specific campaign.
CampaignFolders Folders for organizing campaigns
Campaigns A summary of the campaigns within an account.
EcommerceCartLines A list of an ecommerce cart's lines.
EcommerceCarts A list of an account's ecommerce carts.
EcommerceCustomers A list of an account's ecommerce customers.
EcommerceOrderLines A list of an ecommerce order's lines.
EcommerceOrders A list of an account's ecommerce orders.
EcommerceProducts A list of an account's ecommerce products.
EcommerceProductVariants A list of an ecommerce product's variants.
FileManagerFiles A listing of all avaialable images and files within an account's gallery.
FileManagerFolders A listing of all avaialable folders within an account's gallery.
ListInterestCategories A listing of this list's interest categories.
ListInterests A list of this category's interests
ListMemberEvents Events information for a specific list.
ListMemberNotes The last 10 notes for a specific list member, based on date created.
ListMembers Individuals who are currently or have been previously suscribed to this list, including members who have bounced or unsubscribed.
ListMergeFields The merge field (formerly merge vars) for a given list. These correspond to merge fields in MailChimp's lists and subscriber profiles.
Lists A collection of subscriber lists associated with this account. Lists contain subscribers who have opted-in to receive correspondence from you or your organization.
ListSegmentMembers Individuals who are currently or have been previously suscribed to this list, including members who have bounced or unsubscribed.
ListSegments A list of available segments.
ListsWebhooks Webhooks configured for the given list.
TemplateFolders Folders for organizing templates
Templates A list an account's available templates.
TransactionalAllowlists Get Transactional Allowlists.
TransactionalTags Get Transactional Tags.
TransactionalTemplates Get Transactional Templates.

CampaignFeedback

A summary of the comment feedback for a specific campaign.

Table Specific Information

SELECT, INSERT, UPDATE, and DELTE are supported for CampaignFeedback.

Select

The connector 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 connector.

  • FeedbackId supports the = operator.
  • CampaignId supports the = operator.

For example:

SELECT * FROM CampaignFeedback WHERE FeedbackId = '1245'

SELECT * FROM CampaignFeedback WHERE CampaignId = '1245'
Insert

The CampaignId and Message are required for INSERTs.

INSERT INTO CampaignFeedback (CampaignId, Message) VALUES ('myCampaignId', 'myMessage')
Columns
Name Type ReadOnly Description
FeedbackId [KEY] Integer True The individual ID for the feedback item.
ParentId Integer True If a reply, the ID of the parent feedback item.
BlockId Integer False The block ID for the editable block that the feedback addresses.
Message String False The content of the feedback.
IsComplete Boolean False The status of feedback.
CreatedBy String True The login name of the user who created the feedback.
CreatedAt Datetime True The date and time the feedback item was created.
UpdatedAt Datetime True The date and time the feedback was last updated.
Source String True The source of the feedback ('email', 'sms', 'web', 'ios', 'android', or 'api').
CampaignId [KEY] String False The unique ID for the campaign.

CampaignFolders

Folders for organizing campaigns

Table Specific Information

SELECT, INSERT, UPDATE, and DELTE are supported for CampaignFolders.

Select

The connector 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 connector.

  • Id supports the = operator.

For example:

SELECT * FROM CampaignFolders WHERE ID = '1245'
Columns
Name Type ReadOnly Description
Id [KEY] String True A string that uniquely identifieds this campaign folder
Name String False The name of the folder
Count Integer True The number of campaigns in the folder

Campaigns

A summary of the campaigns within an account.

Table Specific Information

SELECT, UPDATE and DELETE are supported for Campaigns.

Select

The connector 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 connector.

  • Id supports the = operator.
  • Type supports the = operator.
  • CreateTime supports the =, <, >, <=, and >= operators.
  • SendTime supports the =, <, >, <=, and >= operators.
  • Status supports the = operator.
  • Recipients_ListId supports the = operator.
  • Settings_FolderId supports the = operator.
SELECT * FROM Campaigns WHERE Id = '1245'
SELECT * FROM Campaigns WHERE Type = '1245'
SELECT * FROM Campaigns WHERE Status = 'save'
SELECT * FROM Campaigns WHERE Recipients_ListId = '12345'
SELECT * FROM Campaigns WHERE Settings_FolderId = '12345'
SELECT * FROM Campaigns WHERE CreateTime = '2024-02-07 00:00:37.0'
SELECT * FROM Campaigns WHERE CreateTime >= '2024-02-07 00:00:37.0'
SELECT * FROM Campaigns WHERE CreateTime <= '2024-02-07 00:00:37.0'
SELECT * FROM Campaigns WHERE CreateTime > '2024-02-07 00:00:37.0'
SELECT * FROM Campaigns WHERE CreateTime < '2024-02-07 00:00:37.0'
Update
UPDATE Campaigns SET Settings_Title = "Test" WHERE Id = "1234"

UPDATE Campaigns SET Recipients_SegmentOpts = "{"match":"any","saved_segment_id":314699}" WHERE Id = "cfb12c2228"


UPDATE Campaigns SET Settings_Title = "Test", Recipients_ListId = "1234", RssOpts_FeedUrl = "exampleUrl", Type = "rss", RssOpts_Frequency = "daily" WHERE ID = "1234"

Note: UPDATE operation cannot be performed on already SENT campaigns. Also, the type of a campaign cannot be updated once it is set. Depending on the campaign type, specific options can be updateable only for specific campaign types. For example: If a campaign is of type "rss" then only the Rss Options fields can be updateable for this campaign. Variant and AbSplitOps settings will not be updateable in this case.

Columns
Name Type ReadOnly Description
Id [KEY] String True A string that uniquely identifies this campaign.
Type String False The type of campaign (regular, plaintext, absplit, or rss).
CreateTime Datetime True The date and time the campaign was created.
ArchiveUrl String True The link to the campaign's archive version.
LongArchiveUrl String True The original link to the campaign's archive version.
Status String True The current status of the campaign ('save', 'paused', 'schedule', 'sending', 'sent').
EmailsSent Integer True The total number of emails sent for this campaign.
SendTime Datetime True The time and date a campaign was sent.
ContentType String False How the campaign's content is put together ('template', 'drag_and_drop', 'html', 'url').
Recipients_ListId String False The ID of the list.
Recipients_ListName String True The name of the list.
Recipients_SegmentText String False A string marked-up with HTML explaining the segment used for the campaign in plain English.
Recipients_RecipientCount Integer True Count of the recipients on the associated list. Formatted as an integer
Recipients_SegmentOpts String False Segment options.
Settings_SubjectLine String False The subject line for the campaign.
Settings_Title String False The title of the campaign.
Settings_FromName String False The 'from' name on the campaign (not an email address).
Settings_ReplyTo String False The reply-to email address for the campaign.
Settings_UseConversation Boolean False Use Mailchimp Conversation feature to manage out of office replies.
Settings_ToName String False The campaign's custom 'to' name. Typically something like the first name merge var.
Settings_FolderId String False If the campaign is listed in a folder, the ID for that folder.
Settings_Authenticate Boolean False Whether or not the campaign was authenticated by MailChimp. Defaults to 'true'.
Settings_AutoFooter Boolean False Automatically append MailChimp's default footer to the campaign.
Settings_InlineCss Boolean False Automatically inline the CSS included with the campaign content.
Settings_AutoTweet Boolean False Automatically tweet a link to the campaign archive page when the campaign is sent.
Settings_AutoFbPost String False An array of Facebook page ids to auto-post to.
Settings_FbComments Boolean False Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to 'true'.
Settings_Timewarp Boolean True Send this campaign using 'timewarp.' For more info, see the Knowledge Base article: http://eepurl.com/iAgs
Settings_TemplateId Integer False The ID for the template used in this campaign.
Settings_DragAndDrop Boolean True Whether the campaign uses the drag-and-drop editor.
VariateSettings_WinningCombinationId String True ID of the combination that was chosen as the winner
VariateSettings_WinningCampaignId String True ID of the campaign that was sent to the remaining recipients based on the winning combination
VariateSettings_WinnerCriteria String False How the winning campaign will be chosen
VariateSettings_WaitTime Integer False The number of minutes to wait before the winning campaign is picked
VariateSettings_TestSize Integer False The percentage of subscribers to send the test combinations to, from 10 to 100
VariateSettings_SubjectLines String False Possible subject lines
VariateSettings_SendTimes String False Possible send times
VariateSettings_FromNames String False Possible from names
VariateSettings_ReplyToAddresses String False Possible reply To addresses
VariateSettings_Contents String True Descriptions of possible email contents
VariateSettings_Combinations String True Combinations of possible variables that were used to build emails
Tracking_Opens Boolean False Whether to track opens. Defaults to 'true'.
Tracking_HtmlClicks Boolean False Whether to track clicks in the HTML version of the campaign. Defaults to 'true'.
Tracking_TextClicks Boolean False Whether to track clicks in the plain-text version of the campaign. Defaults to 'true'.
Tracking_GoalTracking Boolean False Whether to enable Goal tracking. For more information, see this Knowledge Base article: http://eepurl.com/GPMdH
Tracking_Ecomm360 Boolean False Whether to enable eCommerce360 tracking.
Tracking_GoogleAnalytics String False The custom slug for Google Analytics tracking (max of 50 bytes).
Tracking_Clicktale String False The custom slug for ClickTale Analytics tracking (max of 50 bytes).
Tracking_Salesforce String False Salesforce tracking options for a campaign. Must be using MailChimp's built-in Salesforce integration.
Tracking_Capsule String False Capsule tracking option sfor a campaign. Must be using MailChimp's built-in Capsule integration.
RssOpts_FeedUrl String False The URL for the RSS feed.
RssOpts_Frequency String False The frequency of the RSS-to-Email campaign ('daily', 'weekly', 'monthly').
RssOpts_Schedule String False The schedule for sending the RSS campaign.
RssOpts_LastSent String True The date the campaign was last sent.
RssOpts_ConstrainRssImg Boolean False If true we will add css to images in the rss feed to constrain their width in the campaign content.
AbSplitOpts_SplitTest String False The type of AB split to run ('subject', 'from_name', or 'schedule').
AbSplitOpts_PickWinner String False How we should evaluate a winner. Based on 'opens', 'clicks', or 'manual'.
AbSplitOpts_WaitUnits String False How unit of time for measuring the winner ('hours' or 'days'). This cannot be changed after a campaign is sent.
AbSplitOpts_WaitTime Integer False The amount of time to wait before picking a winner. This cannot be changed after a campaign is sent.
AbSplitOpts_SplitSize Integer False The size of the split groups. Campaigns split based on 'schedule' are forced to have a 50/50 split. Valid split integers are between 1-50. Ex. A 10% split would result in two groups of 10% of the subscribers plus a winner sending to the remaining 80%.
AbSplitOpts_FromNameA String False For campaigns split on 'From Name', the name for Group A.
AbSplitOpts_FromNameB String False For campaigns split on 'From Name', the name for Group B.
AbSplitOpts_ReplyEmailA String False For campaigns split on 'From Name', the reply-to address for Group A.
AbSplitOpts_ReplyEmailB String False For campaigns split on 'From Name', the reply-to address for Group B.
AbSplitOpts_SubjectA String False For campaings split on 'Subject Line', the subject line for Group A.
AbSplitOpts_SubjectB String False For campaings split on 'Subject Line', the subject line for Group B.
AbSplitOpts_SendTimeA Datetime False The send time for Group A.
AbSplitOpts_SendTimeB Datetime False The send time for Group B.
AbSplitOpts_SendTimeWinner Datetime False The send time for the winning version.
SocialCard_ImageUrl String False The URL for the header image for the card.
SocialCard_Description String False A short summary of the campaign to display.
SocialCard_Title String False The title for the card. Typically the subject line of the campaign.
ReportSummary String False For sent campaigns, a summary of opens, clicks, and unsubscribes.
DeliveryStatus String False Updates on campaigns in the process of sending.
WebId Integer True The ID used in the Mailchimp web application. View this campaign in your Mailchimp account at https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}.
ParentCampaignId String True If this campaign is the child of another campaign, this identifies the parent campaign. For Example, for RSS or Automation children.
NeedsBlockRefresh Boolean True Determines if the campaign needs its blocks refreshed by opening the web-based campaign editor. Deprecated and will always return false.
Resendable Boolean True Determines if the campaign qualifies to be resent to non-openers.
Recipients_ListIsActive Boolean True The status of the list used, namely if it's deleted or disabled.
Settings_PreviewText String False The preview text for the campaign.
ItemURL String False The item URL of campaigns.

EcommerceCartLines

A list of an ecommerce cart's lines.

Table Specific Information
Select

The connector 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 connector.

The StoreId can be retrieved by selecting the ECommerceStores view.

  • StoreId supports the = operator.
  • CartId supports the = operator.
  • Id supports the = operator.

For example:

SELECT * FROM EcommerceCartLines WHERE StoreId = 'Test_Store123' and CartId = '44'

SELECT * FROM EcommerceCartLines WHERE StoreId = 'Test_Store123' and CartId = '44' and ID = '88'
Delete

Note : API will throw error if the cart contains only one line item. You will have to delete the cart to delete all the lines.

DELETE FROM EcommerceCartLines WHERE StoreId = 'Test_Store123' and CartId = '44' and ID = '88'
Columns
Name Type ReadOnly Description
StoreId [KEY] String False The StoreId for the table.
CartId [KEY] String False The CartId for the table.
Id [KEY] String False A unique identifier for the cart line item.
ProductId String False A unique identifier for the product associated with the cart line item.
ProductTitle String True The name of the product for the cart line item.
ProductVariantId String False A unique identifier for the product variant associated with the cart line item.
ProductVariantTitle String True The name of the product variant for the cart line item.
Quantity Integer False The quantity of a cart line item.
Price Decimal False The price of a cart line item.

EcommerceCarts

A list of an account's ecommerce carts.

Table Specific Information
Select

The connector 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 connector.

The StoreId can be retrieved by selecting the ECommerceStores view.

  • StoreId supports the = operator.
  • Id supports the = operator.

For example:

SELECT * FROM EcommerceCarts WHERE StoreId = 'Test_Store123'

SELECT * FROM EcommerceCarts WHERE StoreId = 'Test_Store123' and Id = '44'
Columns
Name Type ReadOnly Description
StoreId String False The StoreId for the table.
Id String False A unique identifier for the cart.
Customer String False Information about a specific customer. Carts for existing customers should include only the ID parameter in the customer object body.
CampaignId String False A string that uniquely identifies the campaign associated with a cart.
CheckoutUrl String False The URL for the cart.
CurrencyCode String False The three-letter ISO 4217 code for the currency that the cart uses.
OrderTotal Decimal False The order total for the cart.
TaxTotal Decimal False The total tax for the cart.
Lines String False An array of the cart's line items. The column will not work for Update. Lines can be updated using EcommerceCartLines table.
CreatedAt Datetime True The date and time when the cart was created.
UpdatedAt Datetime True The date and time when the cart was last updated.

EcommerceCustomers

A list of an account's ecommerce customers.

Table Specific Information
Select

The connector 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 connector.

The StoreId can be retrieved by selecting the ECommerceStores view.

  • StoreId supports the = operator.
  • Id supports the = operator.
  • EmailAddress supports the = operator.

For example:

SELECT * FROM EcommerceCustomers WHERE StoreId = 'Test_Store123'

SELECT * FROM EcommerceCustomers WHERE EmailAddress = 'abc@abc.com'

SELECT * FROM EcommerceCustomers WHERE StoreId = 'Test_Store123' and ID = '44'
Columns
Name Type ReadOnly Description
StoreId [KEY] String False The StoreId for the table.
Id [KEY] String False A unique identifier for the customer.
EmailAddress String False The customer's email address.
OptInStatus Boolean False The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints.
Company String False The customer's company.
FirstName String False The customer's first name.
LastName String False The customer's last name.
OrdersCount Integer True The customer's total order count.
TotalSpent Decimal True The total amount the customer has spent.
Address_Address1 String False The mailing address of the customer.
Address_Address2 String False An additional field for the customer's mailing address.
Address_City String False The city the customer is located in.
Address_Province String False The customer's state name or normalized province.
Address_ProvinceCode String False The two-letter code for the customer's province or state.
Address_PostalCode String False The customer's postal or zip code.
Address_Country String False The customer's country.
Address_CountryCode String False The two-letter code for the customer's country.
CreatedAt Datetime True The date and time the customer was created.
UpdatedAt Datetime True The date and time the customer was last updated.

EcommerceOrderLines

A list of an ecommerce order's lines.

Table Specific Information
Select

The connector 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 connector.

The StoreId can be retrieved by selecting the ECommerceStores view.

  • StoreId supports the = operator.
  • OrderId supports the = operator.
  • Id supports the = operator.

For example:

SELECT * FROM EcommerceOrderLines WHERE StoreId = 'Test_Store123' and OrderId = '44'

SELECT * FROM EcommerceOrderLines WHERE StoreId = 'Test_Store123' and OrderId = '44' and ID = '88'
Delete

Note : API will throw error if the Order contains only one line item. You will have to delete the order to delete all the lines.

DELETE FROM EcommerceOrderLines WHERE StoreId = 'Test_Store123' and OrderId = '44' and ID = '88'
Columns
Name Type ReadOnly Description
StoreId [KEY] String False The StoreId for the table.
OrderId [KEY] String False The OrderId for the table.
Id [KEY] String False A unique identifier for the order line item.
ProductId String False A unique identifier for the product associated with the order line item.
ProductTitle String True The name of the product for the order line item.
ProductVariantId String False A unique identifier for the product variant associated with the order line item.
ProductVariantTitle String True The name of the product variant for the order line item.
Quantity Integer False The quantity of an order line item.
Price Decimal False The price of an ecommerce order line item.
Discount Decimal False The total discount amount applied to a line item.
ImageUrl String True The image URL for a product.

EcommerceOrders

A list of an account's ecommerce orders.

Table Specific Information
Select

The connector 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 connector.

The StoreId can be retrieved by selecting the ECommerceStores view.

  • StoreId supports the = operator.
  • Id supports the = operator.
  • CampaignId supports the = operator.
  • Outreach_Id supports the = operator.
  • CustomerId supports the = operator.
  • HasOutreach supports the = operator.

For example:

SELECT * FROM EcommerceOrders WHERE StoreId = 'Test_Store123'
SELECT * FROM EcommerceOrders WHERE StoreId = 'Test_Store123' and Id = '44'
SELECT * FROM EcommerceOrders WHERE CampaignId = '12144'
SELECT * FROM EcommerceOrders WHERE Outreach_Id = '12144'
SELECT * FROM EcommerceOrders WHERE CustomerId = '12144'
SELECT * FROM EcommerceOrders WHERE HasOutreach = true
Columns
Name Type ReadOnly Description
StoreId [KEY] String False The StoreId for the table.
Id [KEY] String False A unique identifier for the order.
Customer String False Information about a specific customer. Orders for existing customers should include only the ID parameter in the customer object body.
CampaignId String False A string that uniquely identifies the campaign associated with an order.
FinancialStatus String False The order status. For example: `refunded`, `processing`, `cancelled`, etc.
FulfillmentStatus String False The fulfillment status for the order. For example: `partial`, `fulfilled`, etc.
CurrencyCode String False The three-letter ISO 4217 code for the currency that the store accepts.
OrderTotal Decimal False The order total for the order.
TaxTotal Decimal False The tax total for the order.
ShippingTotal Decimal False The shipping total for the order.
TrackingCode String False The Mailchimp tracking code for the order. Uses the 'mc_tc' parameter in eCommerce360-enabled tracking URLs.
ProcessedAtForeign Datetime False The date and time the order was processed.
CancelledAtForeign Datetime False The date and time the order was cancelled.
UpdatedAtForeign Datetime False The date and time the order was updated.
ShippingAddress_Name String False The name associated with an order's shipping address.
ShippingAddress_Address1 String False The shipping address for the order.
ShippingAddress_Address2 String False An additional field for the shipping address.
ShippingAddress_City String False The city in the order's shipping address.
ShippingAddress_Province String False The state or normalized province in the order's shipping address.
ShippingAddress_ProvinceCode String False The two-letter code for the province or state the order's shipping address is located in.
ShippingAddress_PostalCode String False The postal or zip code in the order's shipping address.
ShippingAddress_Country String False The country in the order's shipping address.
ShippingAddress_CountryCode String False The two-letter code for the country in the shipping address.
ShippingAddress_Longitude Double False The longitude for the shipping address location.
ShippingAddress_Latitude Double False The latitude for the shipping address location.
ShippingAddress_Phone String False The phone number for the order's shipping address
ShippingAddress_Company String False The company associated with an order's shipping address.
BillingAddress_Name String False The name associated with an order's billing address.
BillingAddress_Address1 String False The billing address for the order.
BillingAddress_Address2 String False An additional field for the billing address.
BillingAddress_City String False The city in the billing address.
BillingAddress_Province String False The state or normalized province in the billing address.
BillingAddress_ProvinceCode String False The two-letter code for the province or state in the billing address.
BillingAddress_PostalCode String False The postal or zip code in the billing address.
BillingAddress_Country String False The country in the billing address.
BillingAddress_CountryCode String False The two-letter code for the country in the billing address.
BillingAddress_Longitude Double False The longitude for the billing address location.
BillingAddress_Latitude Double False The latitude for the billing address location.
BillingAddress_Phone String False The phone number for the billing address.
BillingAddress_Company String False The company associated with the billing address.
Lines String False An array of the order's line items. The column will not work for Update. Lines can be updated using EcommerceOrderLines table.
Outreach_Id String False A unique identifier for the outreach. Can be an email campaign ID.
Outreach_Name String False The name for the outreach.
Outreach_Type String False The type of the outreach.
Outreach_PublishedTime String False The date and time the Outreach was published in ISO 8601 format.
TrackingNumber String False The tracking number associated with the order.
TrackingCarrier String False The tracking carrier associated with the order.
TrackingUrl String False The tracking URL associated with the order.
LandingSite String False The URL for the page where the buyer landed when entering the shop.
Promos String False The promo codes applied on the order.The promo codes applied on the order. Note: Patch will completely replace the value of promos with the new one provided.
OrderUrl String False The URL for the order.
DiscountTotal Decimal False The total amount of the discounts to be applied to the price of the order.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
CustomerId String Filter on customer_id, only valid for SELECT.
HasOutreach Boolean Restrict results to orders that have an outreach attached. For example, an email campaign or Facebook ad, only valid for SELECT.

EcommerceProducts

A list of an account's ecommerce products.

Table Specific Information
Select

The connector 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 connector.

The StoreId can be retrieved by selecting the ECommerceStores view.

  • StoreId supports the = operator.
  • Id supports the = operator.

For example:

SELECT * FROM EcommerceProducts WHERE StoreId = 'Test_Store123'

SELECT * FROM EcommerceProducts WHERE StoreId = 'Test_Store123' and ID = '44'
Columns
Name Type ReadOnly Description
StoreId [KEY] String False The StoreId for the table.
Id [KEY] String False A unique identifier for the product.
Title String False The title of a product.
Handle String False The handle of a product.
Url String False The URL of a product.
Description String False The description of a product.
Type String False The type of product.
Vendor String False The vendor for a product.
ImageUrl String False The image URL for a product.
Variants String False An array of the product's variants.
PublishedAtForeign Datetime False The date and time when the product was published.
CurrencyCode String True The currency code
Images String False An array of the product's images.

EcommerceProductVariants

A list of an ecommerce product's variants.

Table Specific Information
Select

The connector 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 connector.

The StoreId can be retrieved by selecting the ECommerceStores view.

  • StoreId supports the = operator.
  • ProductId supports the = operator.
  • Id supports the = operator.

For example:

SELECT * FROM EcommerceProductVariants WHERE StoreId = 'Test_Store123' and ProductId = '44'

SELECT * FROM EcommerceProductVariants WHERE StoreId = 'Test_Store123' and ProductId = '44' and ID = '88'
Delete

Note : API will throw error if the Product contains only one variant. You will have to delete the product to delete all the variants.

DELETE FROM EcommerceProductVariants WHERE StoreId = 'Test_Store123' and ProductId = '44' and ID = '88'
Columns
Name Type ReadOnly Description
StoreId [KEY] String False The StoreId for the table.
ProductId [KEY] String False The ProductId for the table.
Id [KEY] String False A unique identifier for the product variant.
Title String False The title of a product variant.
Url String False The URL of a product variant.
Sku String False The stock keeping unit (SKU) of a product variant.
Price Decimal False The price of a product variant.
InventoryQuantity Integer False The inventory quantity of a product variant.
ImageUrl String False The image URL for a product variant.
Backorders String False The backorders of a product variant.
Visibility String False The visibility of a product variant.
CreatedAt Datetime True The date and time when the product was created.
UpdatedAt Datetime True The date and time the product was last updated.

FileManagerFiles

A listing of all avaialable images and files within an account's gallery.

Table Specific Information

SELECT, INSERT, UPDATE, and DELETE are supported for FileManagerFiles.

Select

The connector 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 connector.

  • Id supports the = operator.
  • CreatedAt supports the =, <, >, <=, and >= operators.
  • CreatedBy supports the = operator.
  • Type supports the = operator.
SELECT * FROM FileManagerFiles WHERE Id = '1245'
SELECT * FROM FileManagerFiles WHERE CreatedAt = '2024-02-07 00:00:37.0'
SELECT * FROM FileManagerFiles WHERE CreatedAt >= '2024-02-07 00:00:37.0'
SELECT * FROM FileManagerFiles WHERE CreatedAt <= '2024-02-07 00:00:37.0'
SELECT * FROM FileManagerFiles WHERE CreatedAt > '2024-02-07 00:00:37.0'
SELECT * FROM FileManagerFiles WHERE CreatedAt < '2024-02-07 00:00:37.0'
SELECT * FROM FileManagerFiles WHERE CreatedBy = 'abcd'
SELECT * FROM FileManagerFiles WHERE Type = 'file'
Insert

The Name, FolderId, and FileData are required for INSERTs.

INSERT INTO FileManagerFiles (Name, FolderID, FileData) VALUES ('myNewFolder', 'myFolderID', 'myBase64EncodedFileData')
Columns
Name Type ReadOnly Description
Id [KEY] String True The unique ID given to the file.
FolderId Integer False The ID of the folder.
Type String True The type of file in the gallery: Image or file.
Name String False The name of the file.
FullSizeUrl String True The URL of the full-size file.
ThumbnailUrl String True The URL of the thumbnail preview.
Size Integer True The size of the file in bytes.
CreatedAt Datetime True The date and time a file was added to the gallery.
CreatedBy String True The username of the profile that uploaded the file.
Width Integer True The width of the image.
Height Integer True The height of an image.
FileData String False When adding a new file, the base64-encoded file. Required for INSERT statement.

FileManagerFolders

A listing of all avaialable folders within an account's gallery.

Table Specific Information

SELECT, INSERT, UPDATE, and DELETE are supported for FileManagerFolders.

Select

The connector 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 connector.

  • Id supports the = operator.
  • CreatedAt supports the =, <, >, <=, and >= operators.
  • CreatedBy supports the = operator.
SELECT * FROM FileManagerFolders WHERE Id = '1245'
SELECT * FROM FileManagerFolders WHERE CreatedAt = '2024-02-07 00:00:37.0'
SELECT * FROM FileManagerFolders WHERE CreatedAt >= '2024-02-07 00:00:37.0'
SELECT * FROM FileManagerFolders WHERE CreatedAt <= '2024-02-07 00:00:37.0'
SELECT * FROM FileManagerFolders WHERE CreatedAt > '2024-02-07 00:00:37.0'
SELECT * FROM FileManagerFolders WHERE CreatedAt < '2024-02-07 00:00:37.0'
SELECT * FROM FileManagerFolders WHERE CreatedBy = 'abcd'
Insert

The Name is required for INSERTs.

INSERT INTO FileManagerFolders (Name) VALUES ('myNewFolder'')
Columns
Name Type ReadOnly Description
Id [KEY] String True The unique ID given to the folder.
Name String False The name of the folder.
FileCount Integer True The number of files within the folder.
CreatedAt Datetime True The date and time a file was added to the gallery.
CreatedBy String True The username of the profile that created the folder.

ListInterestCategories

A listing of this list's interest categories.

Table Specific Information

SELECT, INSERT, UPDATE, and DELETE are supported for ListInterestCategories.

Select

The connector 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 connector.

  • ListId supports the = operator.
  • Type supports the = operator.
SELECT * FROM ListInterestCategories WHERE ListId = 'abc' and Type='dropdown'
Insert

The Title, Type, and ListId are required for INSERTs.

INSERT INTO ListInterestCategories (Name, Type, ListID) VALUES ('myNewListInterestCategory', 'myType', 'myListID')
Columns
Name Type ReadOnly Description
ListId [KEY] String False The ID for the list that this category belongs to.
Id [KEY] String True
Title String False The text description of this category. This field is displayed on signup forms and is often phrased as a question.
DisplayOrder Integer False Order in which the categories display in the list. Lower numbers display first.
Type String False Determines how this category's interests are displayed on signup forms.

ListInterests

A list of this category's interests

Table Specific Information
Select

The connector 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 connector.

  • Id supports the = operator.
  • CategoryId supports the = operator.
  • ListId supports the = operator.
SELECT * FROM ListInterests WHERE ListId = 'abc' and Id='221'
SELECT * FROM ListInterests WHERE ListId = 'abc' and CategoryId='456'
Insert

The Title, CategoryId, and ListId are required for INSERTs.

INSERT INTO ListInterests (Name, CategoryId, ListID) VALUES ('myNewListInterest', 'myCategory', 'myListID')
Columns
Name Type ReadOnly Description
CategoryId [KEY] String False The ID for the interest category.
ListId [KEY] String False The ID for the list that this interest belongs to.
Id [KEY] String True The ID for the interest.
Name String False The name of the interest. This can be shown publicly on a subscription form.
SubscriberCount String True The number of subscribers associated with this interest.
DisplayOrder Integer False Order in which the interests display.

ListMemberEvents

Events information for a specific list.

Table Specific Information
Select

The connector 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 connector.

  • ListId supports the = operator.
  • MemberId supports the = operator.
SELECT * FROM ListMemberEvents WHERE ListId = '121' and MemberId = '11'
Insert

Name column is required when INSERTing.

Columns
Name Type ReadOnly Description
Name String False The name of the event.
OccurredAt Datetime False The occurred datetime of the event.
Properties String False Properties of the event in an aggregate JSON Format.
ListId String False The unique ID for the list.
MemberId String False The MD5 hash of the list member's email address.

ListMemberNotes

The last 10 notes for a specific list member, based on date created.

Table Specific Information
Select

The connector 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 connector.

  • Id supports the = operator.
  • ListId supports the = operator.
  • MemberId supports the = operator.
SELECT * FROM ListMemberNotes WHERE ListId = '121' and MemberId = '11' and Id='456'
Insert

No fields are are required when INSERTing.

Columns
Name Type ReadOnly Description
Id [KEY] Integer True The note's ID.
CreatedAt Datetime True The date the note was created.
CreatedBy String True The author of the note.
UpdatedAt Datetime True The date the note was last updated
Note String False The content of the note.
ListId [KEY] String False The unique ID for the list.
MemberId [KEY] String False The MD5 hash of the list member's email address.
ContactId String True As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the email_id is the MD5 hash of their email address, this contact_id is agnostic of contact?s inclusion of an email address.
EmailId String True The MD5 hash of the lowercase version of the list member's email address.

ListMembers

Individuals who are currently or have been previously suscribed to this list, including members who have bounced or unsubscribed.

Table Specific Information

SELECT, INSERT, UPDATE, and DELETE are supported for ListMembers.

Select

The connector 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 connector.

  • Id supports the = operator.
  • EmailAddress supports the = operator.
  • UniqueEmailId supports the = operator.
  • EmailType supports the = operator.
  • Status supports the = operator.
  • Vip supports the = operator.
  • ListId supports the = operator.
  • InterestCategoryId supports the = operator.
  • InterestMatch supports the = operator.
  • InterestIds supports the =, and IN operators.
  • SinceLastCampaign supports the = operator.
  • UnsubscribedSince supports the = operator.
  • TimestampOpt supports the =, <, >, <=, and >= operators.
  • LastChanged supports the =, <, >, <=, and >= operators.
SELECT * FROM ListMembers WHERE ListId = '121' and Id='456'
SELECT * FROM ListMembers WHERE EmailAddress = 'abc@abc.com' and EmailType='html'
SELECT * FROM ListMembers WHERE SinceLastCampaign = true and Status='cleaned'
SELECT * FROM ListMembers WHERE UnsubscribedSince = '2024-02-07 00:00:37.0' and Status='unsubscribed'
SELECT * FROM ListMembers WHERE InterestCategoryId = 'abcd' and InterestIds IN ('123','321') and InterestMatch='any'
SELECT * FROM ListMembers WHERE LastChanged = '2024-02-07 00:00:37.0'
SELECT * FROM ListMembers WHERE LastChanged >= '2024-02-07 00:00:37.0'
SELECT * FROM ListMembers WHERE LastChanged <= '2024-02-07 00:00:37.0'
SELECT * FROM ListMembers WHERE LastChanged > '2024-02-07 00:00:37.0'
SELECT * FROM ListMembers WHERE LastChanged < '2024-02-07 00:00:37.0'
Insert

The ListId, EmailAddress, and Status are required for INSERTs.

INSERT INTO ListMembers (ListId, EmailAddress, Status) VALUES ('myListId', 'myEmailAddress', 'subscribed')
Columns
Name Type ReadOnly Description
Id [KEY] String True The MD5 hash of the list member's email address.
EmailAddress String False Email address for a subscriber.
UniqueEmailId [KEY] String True An identifier for the address across all of MailChimp.
EmailType String False Type of email this member asked to get ('html' or 'text').
FullName String True The contact's full name.
Status String False Subscriber's current status ('subscribed', 'unsubscribed', 'cleaned', 'pending' or 'transactional').
StatusIfNew String False Subscriber's status ('subscribed', 'unsubscribed', 'cleaned', or 'pending'), to be used only on a PUT request if the email is not already present on the list.
Interests String False The key of this object's properties is the ID of the interest in question.
Stats_AvgOpenRate Double True A subscriber's average open rate.
Stats_AvgClickRate Double True A subscriber's average clickthrough rate.
IpSignup String False IP address the subscriber signed up from.
TimestampSignup Datetime False Date and time the subscriber signed up for the list.
IpOpt String False IP address the subscriber confirmed their opt-in status.
TimestampOpt Datetime False Date and time the subscribe confirmed their opt-in status.
MemberRating Integer True Star rating for this member between 1 and 5.
LastChanged Datetime True Date and time the member's info was last changed.
Language String False If set/detected, the language of the subscriber.
Vip Boolean False VIP status for subscriber.
EmailClient String True The email client the address as using.
Location_Latitude Double False The location latitude.
Location_Longitude Double False The location longitude.
Location_Gmtoff Integer True The time difference in hours from GMT.
Location_Dstoff Integer True The offset for timezones where daylight saving time is observed.
Location_CountryCode String True The unique code for the location country.
Location_Timezone String True The timezone for the location.
LastNote_NoteId Integer True The note's ID.
LastNote_CreatedAt String True The date the note was created.
LastNote_CreatedBy String True The author of the note.
LastNote_Note String True The content of the note.
ListId [KEY] String False The ID for the list.
TagsAggregate String False Tags of the member, displayed as an aggregate.
ContactId String True As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the ID is the MD5 hash of their email address, this contact_id is agnostic of contact?s inclusion of an email address.
WebId Integer True The ID used in the Mailchimp web application. View this campaign in your Mailchimp account at https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}.
UnsubscribeReason String True A subscriber's reason for unsubscribing.
ConsentsToOneToOneMessaging Boolean True Indicates whether a contact consents to 1:1 messaging.
Stats_EcommerceData_TotalRevenue Decimal True The total revenue the list member has brought in.
Stats_EcommerceData_NumberOfOrders Integer True The total number of orders placed by the list member.
Stats_EcommerceData_CurrencyCode String True The three-letter ISO 4217 code for the currency that the store accepts.
Location_Region String True The region for the location.
MarketingPermissionsAggregate String False The marketing permissions for the subscriber.
Source String True The source from which the subscriber was added to this list.
TagsCount Integer True The number of tags applied to this member.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
InterestCategoryId String The unique ID for the interest category, valid only for SELECT.
InterestMatch String Used to filter list members by interests. Must be accompanied by InterestCategoryId and InterestIds, valid only for SELECT. Possible values: 'any', 'all', or 'none'
InterestIds String Used to filter list members by interests. Must be accompanied by InterestCategoryId and InterestMatch, valid only for SELECT.
SinceLastCampaign Boolean Filter subscribers by those subscribed/unsubscribed/pending/cleaned since last email campaign send. Status is required to use this filter, valid only for SELECT
UnsubscribedSince Datetime Filter subscribers by those unsubscribed since a specific date. Using any status other than unsubscribed with this filter will result in an error, valid only for SELECT

ListMergeFields

The merge field (formerly merge vars) for a given list. These correspond to merge fields in MailChimp's lists and subscriber profiles.

Table Specific Information
Select

The connector 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 connector.

  • MergeId supports the = operator.
  • ListId supports the = operator.
  • Type supports the = operator.
  • Required supports the = operator.
SELECT * FROM ListMergeFields WHERE ListId = 'abc'
SELECT * FROM ListMergeFields WHERE Type = 'address'
SELECT * FROM ListMergeFields WHERE Required = true
SELECT * FROM ListMergeFields WHERE ListId = 'abc' and MergeId = '595'
Insert

The Name and ListID are required for INSERTs.

INSERT INTO ListMergeFields (Name, ListID) VALUES ('myNewListMergeField', 'myListID')
Columns
Name Type ReadOnly Description
MergeId [KEY] Integer True An unchanging ID for the merge field.
Tag String False The tag used in Mailchimp campaigns and for the /members endpoint.
Name String False
Type String False The type for the merge field.
Required Boolean False Boolean value for if the merge field is required
DefaultValue String False The default value for the merge field if null.
Public Boolean False Whether or not the merge field is displayed on the signup form.
DisplayOrder Integer False The order on the form where the merge field is displayed.
Options_DefaultCountry Integer False In an address field, the default country code if none supplied.
Options_PhoneFormat String False In a phone field, the phone number type: US or International.
Options_DateFormat String False In a date or birthday field, the format of the date.
Options_Choices String False In a radio or dropdown non-group field, the available options for members to pick from.
Options_Size Integer False In a text field, the default length of the text field.
HelpText String False Any extra text to help the subscriber.
ListId [KEY] String False A string that identifies this merge field collections' list.

Lists

A collection of subscriber lists associated with this account. Lists contain subscribers who have opted-in to receive correspondence from you or your organization.

Table Specific Information

SELECT, INSERT, UPDATE, and DELETE are supported for Lists.

Select

The connector 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 connector.

  • Id supports the = operator.
  • DateCreated supports the =, <, >, <=, and >= operators.
  • Stats_CampaignLastSent supports the =, <, >, <=, and >= operators.
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 A string that uniquely identifies 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 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 A two-character ISO3166 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 Whether or not 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 lists'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 Whether or not the list supports multiple formats for emails.
SubscribeUrlShort String True Our eepurl shortened version of this list's subscribe form.
SubscribeUrlLong String True The full version of this list's subscribe form (host will vary).
BeamerAddress String True The email address to use for this list's Email Beamer.
Visibility String False Whether this list is public (pub) or private (prv). Used internally for projects like Wavelength.
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 vars for this list (not including the required EMAIL one).
Stats_AvgSubRate Double True The average number of subscriptions per month for the list (not returned if we haven't calculated it yet).
Stats_AvgUnsubRate Double True The average number of unsubscriptions per month for the list (not returned if we haven't calculated it yet).
Stats_TargetSubRate Double True The target numberof subscriptions per month for the list to keep it growing (not returned if we haven't calculated it yet).
Stats_OpenRate Double True The average open rate (a percentage represented as a number between 0 and 100) per campaign for the list (not returned if we haven't calculated it yet).
Stats_ClickRate Double True The average click rate (a percentage represented as a number between 0 and 100) per campaign for the list (not returned if we haven't calculated it 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. View this campaign in your Mailchimp account at https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}.
DoubleOptin Boolean False Whether or not to require the subscriber to confirm subscription via email.
HasWelcome Boolean True Whether or not this list has a welcome automation connected. Welcome Automations: welcomeSeries, singleWelcome, emailFollowup.
MarketingPermissions Boolean False Whether or not the list has marketing permissions (eg. GDPR) enabled.
Stats_TotalContacts Integer True The number of contacts in the list, including subscribed, unsubscribed, pending, cleaned, deleted, transactional, and those that need to be reconfirmed. Requires include_total_contacts query parameter to be included.

ListSegmentMembers

Individuals who are currently or have been previously suscribed to this list, including members who have bounced or unsubscribed.

Table Specific Information

SELECT, INSERT, and DELETE are supported for ListSegmentMembers.

Select

The connector 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 connector.

  • ListId supports the = operator.
  • SegmentId supports the = operator.
  • IncludeCleaned supports the = operator.
  • IncludeTransactional supports the = operator.
  • IncludeUnsubscribed supports the = operator.
SELECT * FROM ListSegmentMembers WHERE ListId = '5152' AND SegmentId = '2623'
SELECT * FROM ListSegmentMembers WHERE IncludeCleaned = true
SELECT * FROM ListSegmentMembers WHERE IncludeTransactional = true
SELECT * FROM ListSegmentMembers WHERE IncludeUnsubscribed = true
Insert

The Name and ListID are required for INSERTs.

INSERT INTO ListSegmentMembers (EmailAddress,ListId,SegmentId) VALUES ('abc@gmail.com','44a64c46cb','7032720')
Columns
Name Type ReadOnly Description
Id [KEY] String True The MD5 hash of the list member's email address.
EmailAddress String False Email address for a subscriber.
UniqueEmailId [KEY] String True An identifier for the address across all of MailChimp.
EmailType String True Type of email this member asked to get ('html' or 'text').
Status String True Subscriber's current status ('subscribed', 'unsubscribed', 'cleaned', or 'pending').
StatusIfNew String True Subscriber's status ('subscribed', 'unsubscribed', 'cleaned', or 'pending'), to be used only on a PUT request if the email is not already present on the list.
Interests String True The key of this object's properties is the ID of the interest in question.
Stats_AvgOpenRate Double True A subscriber's average open rate.
Stats_AvgClickRate Double True A subscriber's average clickthrough rate.
IpSignup String True IP address the subscriber signed up from.
TimestampSignup Datetime True Date and time the subscriber signed up for the list.
IpOpt String True IP address the subscriber confirmed their opt-in status.
TimestampOpt Datetime True Date and time the subscribe confirmed their opt-in status.
MemberRating Integer True Star rating for this member between 1 and 5.
LastChanged Datetime True Date and time the member's info was last changed.
Language String True If set/detected, the language of the subscriber.
Vip Boolean True VIP status for subscriber.
EmailClient String True The email client the address as using.
Location_Latitude Double True
Location_Longitude Double True
Location_Gmtoff Integer True
Location_Dstoff Integer True
Location_CountryCode String True
Location_Timezone String True
LastNote_NoteId Integer True The note's ID.
LastNote_CreatedAt String True The date the note was created.
LastNote_CreatedBy String True The author of the note.
LastNote_Note String True The content of the note.
ListId [KEY] String False The ID for the list.
SegmentId [KEY] String False The ID for the segment.
MergeFields String True A dictionary of merge fields where the keys are the merge tags. See the Merge Fields documentation for more about the structure.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
IncludeCleaned Boolean Include cleaned members in response, only valid for SELECT.
IncludeTransactional Boolean Include transactional members in response, only valid for SELECT
IncludeUnsubscribed Boolean Include unsubscribed members in response, only valid for SELECT

ListSegments

A list of available segments.

Table Specific Information

SELECT, INSERT, UPDATE, and DELETE are supported for ListSegments.

Select

The connector 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 connector.

  • Id supports the = operator.
  • Type supports the = operator.
  • ListId supports the = operator.
  • IncludeCleaned supports the = operator.
  • IncludeUnsubscribed supports the = operator.
  • IncludeTransactional supports the = operator.
  • CreatedAt supports the =, <, >, <=, and >= operators.
  • UpdatedAt supports the =, <, >, <=, and >= operators.
SELECT * FROM ListSegments WHERE ListId = '5152' and Id = '4458'
SELECT * FROM ListSegments WHERE Type = 'saved'
SELECT * FROM ListSegments WHERE IncludeCleaned = true
SELECT * FROM ListSegments WHERE IncludeTransactional = true
SELECT * FROM ListSegments WHERE IncludeUnsubscribed = true
SELECT * FROM ListSegments WHERE UpdatedAt = '2024-02-07 00:00:37.0'
SELECT * FROM ListSegments WHERE UpdatedAt >= '2024-02-07 00:00:37.0'
SELECT * FROM ListSegments WHERE UpdatedAt <= '2024-02-07 00:00:37.0'
SELECT * FROM ListSegments WHERE UpdatedAt > '2024-02-07 00:00:37.0'
SELECT * FROM ListSegments WHERE UpdatedAt < '2024-02-07 00:00:37.0'
Insert

The Name and ListID are required for INSERTs.

INSERT INTO ListSegments (Name, ListID) VALUES ('myNewListSegment', 'myListID')
Columns
Name Type ReadOnly Description
Id [KEY] String True An integer to uniquely identify the segment.
Name String False The name of the segment.
MemberCount Integer True The number of active subscribers currently included in the segment.
Type String True The type of segment: saved, static, or fuzzy.
CreatedAt Datetime True The time and date the segment was created.
UpdatedAt Datetime True The time and date the segment was last updated.
Options_Match String False Match type of 'any' or 'all'.
Options_Conditions String False An array of segment conditions.
ListId [KEY] String False The ID for the list.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
EmailList String A comma-separated list of emails that you want to include in this ListSegment.
IncludeCleaned Boolean Include cleaned members in response, only valid for SELECT
IncludeTransactional Boolean Include transactional members in response, only valid for SELECT
IncludeUnsubscribed Boolean Include unsubscribed members in response, only valid for SELECT

ListsWebhooks

Webhooks configured for the given list.

Columns
Name Type ReadOnly Description
Id [KEY] String True An identifier for the webhook across all of MailChimp.
Url String False the URL for this Webhook.
Events_Subscribe Boolean False
Events_Unsubscribe Boolean False
Events_Profile Boolean False
Events_Cleaned Boolean False
Events_Upemail Boolean False
Events_Campaign Boolean False
Sources_User Boolean False
Sources_Admin Boolean False
Sources_Api Boolean False
ListId [KEY] String False The ID for the list.

TemplateFolders

Folders for organizing templates

Table Specific Information

SELECT, INSERT, UPDATE, and DELTE are supported for TemplateFolders.

Select

The connector 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 connector.

  • Id supports the = operator.

For example:

SELECT * FROM TemplateFolders WHERE ID = '1245'
Columns
Name Type ReadOnly Description
Id [KEY] String True A string that uniquely identifieds this folder
Name String False The name of the folder
Count Integer True The number of templates in the folder

Templates

A list an account's available templates.

Table Specific Information

SELECT, INSERT, UPDATE and DELETE are supported for Templates.

Select

The connector 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 connector.

  • Id supports the = operator.
  • Type supports the = operator.
  • Category supports the = operator.
  • DateCreated supports the =, <, >, <=, and >= operators.
  • CreatedBy supports the = operator.
  • FolderId supports the = operator.
  • ContentType supports the = operator.
SELECT * FROM Templates WHERE Id = '1245'
SELECT * FROM Templates WHERE Type = 'base'
SELECT * FROM Templates WHERE Category = 'asdw'
SELECT * FROM Templates WHERE FolderId = '15151'
SELECT * FROM Templates WHERE ContentType = 'template'
SELECT * FROM Templates WHERE CreatedBy = 'abcd'
SELECT * FROM Templates WHERE DateCreated = '2024-02-07 00:00:37.0'
SELECT * FROM Templates WHERE DateCreated >= '2024-02-07 00:00:37.0'
SELECT * FROM Templates WHERE DateCreated <= '2024-02-07 00:00:37.0'
SELECT * FROM Templates WHERE DateCreated > '2024-02-07 00:00:37.0'
SELECT * FROM Templates WHERE DateCreated < '2024-02-07 00:00:37.0'
Insert

Columns Name and Html are required for Insert.

INSERT INTO Templates(name, html) VALUES ('test_template', '<title></title>')
Update

Column Html is required for Update. As the html column is not returned from the server during SELECT operation, the user will have to provider HTML column in the UPDATE statement.

Update Templates set html='<title></title>', name='abcd' where id=13693
Delete
Delete from Templates where id=13695
Columns
Name Type ReadOnly Description
Id [KEY] Integer True The individual ID for the template.
Type String True The type of template (user, base, or gallery).
Name String False The name of the template.
DragAndDrop Boolean True Whether or not the template uses the drag and drop editor.
Responsive Boolean True Whether or not the template contains media queries to make it responsive.
Category String True If available, the category the template is listed in.
DateCreated Datetime True The date and time the template was created.
CreatedBy String True The login name for template's creator.
Active Boolean True User templates are not 'deleted,' but rather marked as 'inactive.' Returns whether or not the template is still active.
FolderId String False The ID of the folder the template is currently in.
Thumbnail String True If available, the URL for a thumbnail of the template.
ShareUrl String True The URL used for template sharing. For more information, see: http://kb.mailchimp.com/templates/basic-and-themes/how-to-share-a-template
ContentType String True How the template's content is put together. The allowed values are template, multichannel, html.
DateEdited Datetime True The date and time the template was edited in ISO 8601 format.
EditedBy String True The login name who last edited the template.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
Html String The raw HTML for the template. We support the Mailchimp Template Language in any HTML code passed via the API. Can be used for INSERT and UPDATE

TransactionalAllowlists

Get Transactional Allowlists.

Table Specific Information

SELECT, INSERT and DELETE is supported for TransactionalAllowlists.

Select

The connector 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 connector.

  • Email supports the = operator.
SELECT * FROM TransactionalAllowlists WHERE Email = 'test@gmail.com'
Insert

Email is required for Insert operation.

INSERT INTO TransactionalAllowlists(Email) VALUES ('abc@test.com')
Delete

Email is required for Delete operation.

DELETE FROM TransactionalAllowlists WHERE Email = 'abc@test.com'
Columns
Name Type ReadOnly Description
Email [KEY] String False An email address to add to the allowlist.
CreatedAt Datetime True A description of why the email was allowlisted.
Detail String True When the email was added to the allowlist.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
Comment String An optional description of why the email was added to the allowlist. Only used for INSERT.

TransactionalTags

Get Transactional Tags.

Table Specific Information

SELECT and DELETE are supported for TransactionalTags.

Select

The connector 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 connector.

  • Tag supports the = operator.
SELECT * FROM TransactionalTags WHERE Tag = 'welcome'
Delete

Tag is required for the DELETE operation.

DELETE FROM TransactionalTags WHERE Tag = 'welcome'
Columns
Name Type ReadOnly Description
Tag [KEY] String True The actual tag as a string.
Reputation Integer True The tag's current reputation on a scale from 0 to 100.
Sent Integer True The total number of messages sent by this sender.
HardBounces Integer True The total number of hard bounces by messages by this sender.
SoftBounces Integer True The total number of soft bounces by messages by this sender.
Rejects Integer True The total number of rejected messages by this sender.
Complaints Integer True The total number of spam complaints received for messages by this sender.
Unsubs Integer True The total number of unsubscribe requests received for messages by this sender.
Opens Integer True The total number of times messages by this sender have been opened.
Clicks Integer True The total number of times tracked URLs in messages by this sender have been clicked.
UniqueOpens Integer True The number of unique opens for emails sent for this sender.
UniqueClicks Integer True The number of unique clicks for emails sent for this sender.
StatsTodaySent Integer True The number of emails sent with this tag so far today. This column will populated when ID is specified in WHERE clause.
StatsTodayHardBounces Integer True The number of emails hard bounced with this tag so far today. This column will populated when ID is specified in WHERE clause.
StatsTodaySoftBounces Integer True The number of emails soft bounced with this tag so far today. This column will populated when ID is specified in WHERE clause.
StatsTodayRejects Integer True The number of emails rejected for sending this sender so far today. This column will populated when ID is specified in WHERE clause.
StatsTodayComplaints Integer True The number of spam complaints with this tag so far today. This column will populated when ID is specified in WHERE clause.
StatsTodayUnsubs Integer True The number of unsubscribes with this tag so far today. This column will populated when ID is specified in WHERE clause.
StatsTodayOpens Integer True The number of times emails have been opened with this tag so far today. This column will populated when ID is specified in WHERE clause.
StatsTodayClicks Integer True The number of URLs that have been clicked with this tag so far today. This column will populated when ID is specified in WHERE clause.
StatsTodayUniqueOpens Integer True The number of unique opens for emails sent with this tag so far today. This column will populated when ID is specified in WHERE clause.
StatsTodayUniqueClicks Integer True The number of unique clicks for emails sent with this tag so far today. This column will populated when ID is specified in WHERE clause.
StatsLast7DaysSent Integer True The number of emails sent with this tag in the last 7 days. This column will populated when ID is specified in WHERE clause.
StatsLast7DaysHardBounces Integer True The number of emails hard bounced with this tag in the last 7 days. This column will populated when ID is specified in WHERE clause.
StatsLast7DaysSoftBounces Integer True The number of emails soft bounced with this tag in the last 7 days. This column will populated when ID is specified in WHERE clause.
StatsLast7DaysRejects Integer True The number of emails rejected for sending this sender in the last 7 days. This column will populated when ID is specified in WHERE clause.
StatsLast7DaysComplaints Integer True The number of spam complaints with this tag in the last 7 days. This column will populated when ID is specified in WHERE clause.
StatsLast7DaysUnsubs Integer True The number of unsubscribes with this tag in the last 7 days. This column will populated when ID is specified in WHERE clause.
StatsLast7DaysOpens Integer True The number of times emails have been opened with this tag in the last 7 days. This column will populated when ID is specified in WHERE clause.
StatsLast7DaysClicks Integer True The number of URLs that have been clicked with this tag in the last 7 days. This column will populated when ID is specified in WHERE clause.
StatsLast7DaysUniqueOpens Integer True The number of unique opens for emails sent with this tag in the last 7 days. This column will populated when ID is specified in WHERE clause.
StatsLast7DaysUniqueClicks Integer True The number of unique clicks for emails sent with this tag in the last 7 days. This column will populated when ID is specified in WHERE clause.
StatsLast30DaysSent Integer True The number of emails sent with this tag in the last 30 days. This column will populated when ID is specified in WHERE clause.
StatsLast30DaysHardBounces Integer True The number of emails hard bounced with this tag in the last 30 days. This column will populated when ID is specified in WHERE clause.
StatsLast30DaysSoftBounces Integer True The number of emails soft bounced with this tag in the last 30 days. This column will populated when ID is specified in WHERE clause.
StatsLast30DaysRejects Integer True The number of emails rejected for sending this sender in the last 30 days. This column will populated when ID is specified in WHERE clause.
StatsLast30DaysComplaints Integer True The number of spam complaints with this tag in the last 30 days. This column will populated when ID is specified in WHERE clause.
StatsLast30DaysUnsubs Integer True The number of unsubscribes with this tag in the last 30 days. This column will populated when ID is specified in WHERE clause.
StatsLast30DaysOpens Integer True The number of times emails have been opened with this tag in the last 30 days. This column will populated when ID is specified in WHERE clause.
StatsLast30DaysClicks Integer True The number of URLs that have been clicked with this tag in the last 30 days. This column will populated when ID is specified in WHERE clause.
StatsLast30DaysUniqueOpens Integer True The number of unique opens for emails sent with this tag in the last 30 days. This column will populated when ID is specified in WHERE clause.
StatsLast30DaysUniqueClicks Integer True The number of unique clicks for emails sent with this tag in the last 30 days. This column will populated when ID is specified in WHERE clause.
StatsLast60DaysSent Integer True The number of emails sent with this tag in the last 60 days. This column will populated when ID is specified in WHERE clause.
StatsLast60DaysHardBounces Integer True The number of emails hard bounced with this tag in the last 60 days. This column will populated when ID is specified in WHERE clause.
StatsLast60DaysSoftBounces Integer True The number of emails soft bounced with this tag in the last 60 days. This column will populated when ID is specified in WHERE clause.
StatsLast60DaysRejects Integer True The number of emails rejected for sending this sender in the last 60 days. This column will populated when ID is specified in WHERE clause.
StatsLast60DaysComplaints Integer True The number of spam complaints with this tag in the last 60 days. This column will populated when ID is specified in WHERE clause.
StatsLast60DaysUnsubs Integer True The number of unsubscribes with this tag in the last 60 days. This column will populated when ID is specified in WHERE clause.
StatsLast60DaysOpens Integer True The number of times emails have been opened with this tag in the last 60 days. This column will populated when ID is specified in WHERE clause.
StatsLast60DaysClicks Integer True The number of URLs that have been clicked with this tag in the last 60 days. This column will populated when ID is specified in WHERE clause.
StatsLast60DaysUniqueOpens Integer True The number of unique opens for emails sent with this tag in the last 60 days. This column will populated when ID is specified in WHERE clause.
StatsLast60DaysUniqueClicks Integer True The number of unique clicks for emails sent with this tag in the last 60 days. This column will populated when ID is specified in WHERE clause.
StatsLast90DaysSent Integer True The number of emails sent with this tag in the last 90 days. This column will populated when ID is specified in WHERE clause.
StatsLast90DaysHardBounces Integer True The number of emails hard bounced with this tag in the last 90 days. This column will populated when ID is specified in WHERE clause.
StatsLast90DaysSoftBounces Integer True The number of emails soft bounced with this tag in the last 90 days. This column will populated when ID is specified in WHERE clause.
StatsLast90DaysRejects Integer True The number of emails rejected for sending this sender in the last 90 days. This column will populated when ID is specified in WHERE clause.
StatsLast90DaysComplaints Integer True The number of spam complaints with this tag in the last 90 days. This column will populated when ID is specified in WHERE clause.
StatsLast90DaysUnsubs Integer True The number of unsubscribes with this tag in the last 90 days. This column will populated when ID is specified in WHERE clause.
StatsLast90DaysOpens Integer True The number of times emails have been opened with this tag in the last 90 days. This column will populated when ID is specified in WHERE clause.
StatsLast90DaysClicks Integer True The number of URLs that have been clicked with this tag in the last 90 days. This column will populated when ID is specified in WHERE clause.
StatsLast90DaysUniqueOpens Integer True The number of unique opens for emails sent with this tag in the last 90 days. This column will populated when ID is specified in WHERE clause.
StatsLast90DaysUniqueClicks Integer True The number of unique clicks for emails sent with this tag in the last 90 days. This column will populated when ID is specified in WHERE clause.

TransactionalTemplates

Get Transactional Templates.

Table Specific Information

SELECT, INSERT, UPDATE, and DELETE operations are supported for TransactionalTemplates.

Select

The connector will use the Mailchimp API to process WHERE clause conditions built with the following columns and operator. The rest of the filter is executed client-side within the connector.

  • Name supports the = operator.
  • Label supports the = operator.
SELECT * FROM TransactionalTemplates WHERE Name = 'MyTemplate'
SELECT * FROM TransactionalTemplates WHERE Label = 'MyLabel'
Insert

Name is required for the INSERT operation.

INSERT INTO TransactionalTemplates (Name, Subject, FromEmail, FromName, Publish) VALUES ('MyTemplate', 'Hello Subject', 'sender@example.com', 'Sender Name', true)
Update

Name is required for the UPDATE operation as it acts as the key.

UPDATE TransactionalTemplates SET labels='[\"adw\", \"eww\"]' WHERE name='testname'
Delete

Name is required for the DELETE operation.

DELETE FROM TransactionalTemplates WHERE Name = 'MyTemplate'
Columns
Name Type ReadOnly Description
Name [KEY] String False The name of the template.
Slug String True The immutable unique code name of the template.
CreatedAt Datetime True The UTC timestamp when the template was created, in YYYY-MM-DD HH:MM:SS format.
UpdatedAt Datetime True The date and time the template was last modified as a UTC string in YYYY-MM-DD HH:MM:SS format.
Labels String False The list of labels applied to the template.
Code String False The full HTML code of the template, with mc:edit attributes marking the editable elements - draft version.
Subject String False The subject line of the template, if provided - draft version.
FromEmail String False The default sender address for the template, if provided - draft version.
FromName String False The default sender from name for the template, if provided - draft version.
Text String False The default text part of messages sent with the template, if provided - draft version.
PublishName String True The same as the template name - kept as a separate field for backwards compatibility.
PublishCode String True The full HTML code of the template, with mc:edit attributes marking the editable elements that are available as published, if it has been published.
PublishSubject String True The subject line of the template, if provided.
PublishFromEmail String True The default sender address for the template, if provided.
PublishFromName String True The default sender from name for the template, if provided.
PublishText String True The default text part of messages sent with the template, if provided.
PublishedAt Datetime True The date and time the template was last published as a UTC string in YYYY-MM-DD HH:MM:SS format, or null if it has not been published.
IsBrokenTemplate Boolean True Indicates if the template is malformed or corrupt.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
Label String An optional label to filter the templates. Only used for SELECT.
Publish Boolean Set to false to add a draft template without publishing. Only used for INSERT and UPDATE.

Views

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

Mailchimp Connector Views

Name Description
AccountExports Generate a new account export or download a finished account export.
AuthorizedApps A list of applications authorized to access the account.
AutomationEmailQueues A summary of the queue for an email in an automation workflow.
AutomationEmails A summary of the emails in an automation workflow.
Automations A summary of the automations within an account.
AutomationsRemovedSubscribers A summary of the subscribers removed from an automation workflow.
BatchOperations Get a summary of batch requests that have been made.
CampaignContents Get the the HTML and plain-text content for a campaign.
CampaignOpenEmailDetails A list of members who opened the campaign email.
CampaignSendCheckList Review the send checklist for a campaign, and resolve any issues before sending.
CampaignVariateContents Get the the HTML and plain-text content for a campaign.
ChimpChatterActivity Return the Chimp Chatter for this account ordered by most recent.
ConnectedSites Get all connected sites in an account.
ConversationMessages Messages from a specific conversation. Conversation tracking is a feature available to paid accounts that lets you view replies to your campaigns from inside your Mailchimp account.
Conversations A collection of this account's tracked conversations. Conversation tracking is a feature available to paid accounts that lets you view replies to your campaigns from inside your Mailchimp account.
EcommerceProductImages A Product Image represents a specific product image.
EcommercePromoCodes Retrieves the list of promo codes under a promo rule
EcommercePromoRules Get information about a store's promo rules
EcommerceStores A list of an account's ecommerce stores.
ListAbuse A collection of abuse complaints for a specific list. An abuse complaint occurs when your recipient clicks to 'report spam' in their email program.
ListActivity Up to the previous 180 days of daily detailed aggregated activity stats for a given list. Does not include AutoResponder or Automation activity.
ListClients Top email clients used, as measured by their user-agent string
ListGrowthHistory A month-by-month summary of a specific list's growth activity.
ListMemberActivity The last 50 member events for a list.
ListMemberTags Tags assigned to a certain member/members.
ListSignupForms Collection of List Signup Forms
ReportAbuse A list of abuse complaints for a specific list.
ReportAdvice A list of feedback based on a campaign's statistics.
ReportClickDetails A list of URLs and unique IDs included in HTML and plain-text versions of a campaign.
ReportClickDetailsMembers A collection of members who clicked on a specific link within a campaign.
ReportDomainPerformance Statistics for the top-performing email domains in a campaign.
ReportEmailActivity A list of member's subscriber activity in a specific campaign.
ReportLocations Top open locations for a specific campaign.
Reports A list of reports containing campaigns marked as Sent.
ReportSentTo A list of subscribers who were sent a specific campaign.
ReportUnsubscribes A list of members who have unsubscribed from a specific campaign.
SurveyResponses List of survey responses.
Surveys Get reports for surveys.
TransactionalScheduledEmails Get Transactional Scheduled Emails.
TransactionalSenders Get Transactional Senders.
TransactionalUserInfos Get Transactional user info.

AccountExports

Generate a new account export or download a finished account export.

Table Specific Information
Select

The connector 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 connector.

  • Id supports the = operator.

For example:

SELECT * FROM AccountExports;
SELECT * FROM AccountExports where Id=3191;
Columns
Name Type Description
Id [KEY] Integer The ID for the export.
Started Datetime Start time for the export.
Finished Datetime If finished, the finish time for the export.
SizeInBytes Integer The size of the uncompressed export in bytes.
DownloadUrl String If the export is finished, the download URL for an export. URLs are only valid for 90 days after the export completes.
Links String A list of link types and descriptions for the API schema documents.

AuthorizedApps

A list of applications authorized to access the account.

Table Specific Information
Select

The connector 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 connector.

  • Id supports the = operator.

For example:

SELECT * FROM AuthorizedApps WHERE ID = '1245'
Columns
Name Type Description
Id [KEY] String The ID for this application integration.
Name String The name of the application.
Description String The description for the application.
Users String An array of usernames of the users who have linked this app.

AutomationEmailQueues

A summary of the queue for an email in an automation workflow.

Table Specific Information
Select

The connector 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 connector.

  • Id supports the = operator.
  • WorkflowId supports the = operator.
  • EmailId supports the = operator.

For example:

SELECT * FROM AutomationEmailQueues WHERE Id = '1245'

SELECT * FROM AutomationEmailQueues WHERE WorkflowId = '1245' and EmailId = '1245'
Columns
Name Type Description
Id [KEY] String The MD5 hash of the lowercase version of the list member's email address.
WorkflowId [KEY] String A string that uniquely identifies an automation workflow.
EmailId [KEY] String A string that uniquely identifies an email in an automation workflow.
ListId String A string that uniquely identifies a list.
EmailAddress String Email Address
NextSend String Next Send

AutomationEmails

A summary of the emails in an automation workflow.

Table Specific Information
Select

The connector 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 connector.

  • WorkflowId supports the = operator.

For example:

SELECT * FROM AutomationEmails WHERE WorkflowId = '1245'
Columns
Name Type Description
Id [KEY] String A string that uniquely identifies the automation email.
WorkflowId [KEY] String A string that uniquely identifies an automation workflow.
Position Integer
Delay_Amount Integer The delay amount for an automation email.
Delay_Type String The type of delay for an automation email.
Delay_Direction String Whether the delay settings describe before or after the delay action of an automation email.
Delay_Action String The action that triggers the delay of an automation emails.
CreateTime Datetime The date and time the campaign was created.
StartTime Datetime The date and time the campaign was started.
ArchiveUrl String The link to the campaign's archive version.
Status String The current status of the campaign ('save', 'paused', 'sending').
EmailsSent Integer The total number of emails sent for this campaign.
SendTime Datetime The time and date a campaign was sent.
ContentType String How the campaign's content is put together ('template', 'drag_and_drop', 'html', 'url').
Recipients_ListId String The ID of the list.
Recipients_SegmentOpts String Segment options.
Settings_SubjectLine String The subject line for the campaign.
Settings_Title String The title of the campaign.
Settings_FromName String The 'from' name on the campaign (not an email address).
Settings_ReplyTo String The reply-to email address for the campaign.
Settings_Authenticate Boolean Whether or not the campaign was authenticated by MailChimp. Defaults to 'true'.
Settings_AutoFooter Boolean Automatically append MailChimp's default footer to the campaign.
Settings_InlineCss Boolean Automatically inline the CSS included with the campaign content.
Settings_AutoTweet Boolean Automatically tweet a link to the campaign archive page when the campaign is sent.
Settings_AutoFbPost String An array of Facebook page ids (integers) to auto-post to.
Settings_FbComments Boolean Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to 'true'.
Settings_TemplateId Integer The ID for the template used in this campaign.
Settings_DragAndDrop Boolean Whether the campaign uses the drag-and-drop editor.
Tracking_Opens Boolean Whether to track opens. Defaults to 'true'.
Tracking_HtmlClicks Boolean Whether to track clicks in the HTML version of the campaign. Defaults to 'true'.
Tracking_TextClicks Boolean Whether to track clicks in the plain-text version of the campaign. Defaults to 'true'.
Tracking_GoalTracking Boolean Whether to enable Goal racking. For more information, see this Knowledge Base article: http://eepurl.com/GPMdH
Tracking_Ecomm360 Boolean Whether to enable eCommerce360 tracking.
Tracking_GoogleAnalytics String The custom slug for Google Analytics tracking (max of 50 bytes).
Tracking_Clicktale String The custom slug for ClickTale Analytics tracking (max of 50 bytes).
Tracking_Salesforce String Salesforce tracking options for a campaign. Must be using MailChimp's built-in Salesforce integration.
Tracking_Capsule String Capsule tracking option sfor a campaign. Must be using MailChimp's built-in Capsule integration.
SocialCard_ImageUrl String The URL for the header image for the card.
SocialCard_Description String A short summary of the campaign to display.
SocialCard_Title String The title for the card. Typically the subject line of the campaign.
TriggerSettings_Runtime String The advanced scheduling options for an automation email.
ReportSummary String For sent campaigns, a summary of opens, clicks, and unsubscribes.
WebId Integer The ID used in the Mailchimp web application. View this campaign in your Mailchimp account at https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}.
TriggerSettings_WorkflowType String The type of Automation workflow. The allowed values are abandonedBrowse, abandonedCart, api, bestCustomers, categoryFollowup, dateAdded, emailFollowup, emailSeries, groupAdd, groupRemove, mandrill, productFollowup, purchaseFollowup, recurringEvent, specialEvent, visitUrl, welcomeSeries.
TriggerSettings_WorkflowTitle String The title of the workflow type.
TriggerSettings_WorkflowEmailsCount Integer The number of emails in the Automation workflow.
Delay_ActionDescription String The user-friendly description of the action that triggers an Automation email.
Delay_FullDescription String The user-friendly description of the delay and trigger action settings for an Automation email.
NeedsBlockRefresh Boolean Determines if the automation email needs its blocks refreshed by opening the web-based campaign editor.
HasLogoMergeTag Boolean Determines if the campaign contains the |BRAND:LOGO| merge tag
Recipients_ListIsActive Boolean The status of the list used, namely if it's deleted or disabled.
Recipients_ListName String The name of the list
Recipients_RecipientCount Integer Count of the recipients on the associated list. Formatted as an integer.
Recipients_SegmentText String A description of the segment used for the campaign. Formatted as a string marked up with HTML.
Settings_PreviewText String The preview text for the campaign.

Automations

A summary of the automations within an account.

Table Specific Information
Select

The connector 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 connector.

  • Id supports the = operator.
  • CreateTime supports the =, <, >, <=, and >= operators.
  • StartTime supports the =, <, >, <=, and >= operators.
  • Status supports the = operator.

For example:

SELECT * FROM Automations WHERE Id = '1245'
SELECT * FROM Automations WHERE Status = 'save'
SELECT * FROM Automations WHERE CreateTime = '2024-02-07 00:00:37.0'
SELECT * FROM Automations WHERE CreateTime >= '2024-02-07 00:00:37.0'
SELECT * FROM Automations WHERE CreateTime <= '2024-02-07 00:00:37.0'
SELECT * FROM Automations WHERE CreateTime > '2024-02-07 00:00:37.0'
SELECT * FROM Automations WHERE CreateTime < '2024-02-07 00:00:37.0'
Columns
Name Type Description
Id [KEY] String A string that identifies this automation.
CreateTime Datetime The date and time the automation was created.
StartTime Datetime The date and time the automation was started.
Status String The current status of the automation ('save', 'paused', 'sending').
EmailsSent Integer The total number of emails sent for this automation.
Recipients_ListId String The ID of the list.
Recipients_ListName String List Name
Recipients_SegmentOpts String Segment options.
Settings_Title String The title of the automation.
Settings_FromName String The 'from' name on the automation (not an email address).
Settings_ReplyTo String The reply-to email address for the automation.
Settings_UseConversation Boolean Use MailChimp's Conversations feature to manage out of office replies.
Settings_ToName String The automation's custom 'to' name. Typically something like the first name merge var.
Settings_Authenticate Boolean Whether or not the automation is authenticated by MailChimp. Defaults to 'true'.
Settings_AutoFooter Boolean Automatically append MailChimp's default footer to the automation.
Settings_InlineCss Boolean Automatically inline the CSS included with the automation content.
Tracking_Opens Boolean Whether to track opens. Defaults to 'true'.
Tracking_HtmlClicks Boolean Whether to track clicks in the HTML version of the automation. Defaults to 'true'.
Tracking_TextClicks Boolean Whether to track clicks in the plain-text version of the automation. Defaults to 'true'.
Tracking_GoalTracking Boolean Whether to enable Goal tracking. For more information, see this Knowledge Base article: http://eepurl.com/GPMdH
Tracking_Ecomm360 Boolean Whether to enable eCommerce360 tracking.
Tracking_GoogleAnalytics String The custom slug for Google Analytics tracking (max of 50 bytes).
Tracking_Clicktale String The custom slug for ClickTale Analytics tracking (max of 50 bytes).
Tracking_Salesforce String Salesforce tracking options for an automation. Must be using MailChimp's built-in Salesforce integration.
Tracking_Capsule String Capsule tracking options for an automation. Must be using MailChimp's built-in Capsule integration.
TriggerSettings String A summary of an automation workflow's trigger settings.
ReportSummary String A summary of open and click activity for an automation workflow.
Recipients_ListIsActive Boolean The status of the list used, namely if it's deleted or disabled.
Recipients_StoreId String The ID of the store.

AutomationsRemovedSubscribers

A summary of the subscribers removed from an automation workflow.

Table Specific Information
Select

The connector 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 connector.

  • WorkflowId supports the = operator.

For example:

SELECT * FROM AutomationsRemovedSubscribers WHERE WorkflowId = '1245'
Columns
Name Type Description
Id [KEY] String The MD5 hash of the lowercase version of the list member's email address.
WorkflowId [KEY] String A string that uniquely identifies an automation workflow.
ListId String A string that uniquely identifies a list.
EmailAddress String Email Address

BatchOperations

Get a summary of batch requests that have been made.

Table Specific Information
Select

The connector 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 connector.

  • Id supports the = operator.

For example:

SELECT * FROM BatchOperations;
SELECT * FROM BatchOperations where Id=2;
Columns
Name Type Description
Id [KEY] String A string that uniquely identifies this batch request.
Status String The status of the batch call. Learn more about the batch operation status The allowed values are pending, preprocessing, started, finalizing, finished.
TotalOperations Integer The total number of operations to complete as part of this batch request. For GET requests requiring pagination, each page counts as a separate operation.
FinishedOperations Integer The number of completed operations. This includes operations that returned an error.
ErroredOperations Integer The number of completed operations that returned an error.
SubmittedAt Datetime The date and time when the server received the batch request in ISO 8601 format.
CompletedAt Datetime The date and time when all operations in the batch request completed in ISO 8601 format.
ResponseBodyUrl String The URL of the gzipped archive of the results of all the operations.
Links String A list of link types and descriptions for the API schema documents.

CampaignContents

Get the the HTML and plain-text content for a campaign.

Table Specific Information
Select

The connector 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 connector.

The CamapignId can be retrieved by selecting the Campaigns table.

  • CamapaignId supports the = operator.

For example:

SELECT * FROM CampaignContents;
SELECT * FROM CampaignContents where CampaignId='381b6f0c90';
Columns
Name Type Description
CampaignId String The unique ID for the campaign.
PlainText String The plain-text portion of the campaign. If left unspecified, we'll generate this automatically.
Html String The raw HTML for the campaign.
ArchiveHtml String The Archive HTML for the campaign.

CampaignOpenEmailDetails

A list of members who opened the campaign email.

Table Specific Information
Select

The connector 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 connector.

  • CampaignId supports the = operator.
  • Since supports the = operator.

For example:

SELECT * FROM CampaignOpenEmailDetails
SELECT * FROM CampaignOpenEmailDetails WHERE CampaignId = '9f218dcf18'
SELECT * FROM CampaignOpenEmailDetails WHERE Since = '2024-02-07 00:00:37.0'
Columns
Name Type Description
CampaignId [KEY] String The ID for this application integration.
ListId [KEY] String The name of the application.
ListIsActive Boolean The description for the application.
ContactStatus String An array of usernames of the users who have linked this app.
EmailId [KEY] String The description for the application.
EmailAddress String The description for the application.
MergeFields String The description for the application.
Vip Boolean The description for the application.
OpensCount Integer The description for the application.
Opens String The description for the application.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
Since Datetime Restrict results to campaign open events that occur after a specific time.

CampaignSendCheckList

Review the send checklist for a campaign, and resolve any issues before sending.

Columns
Name Type Description
CampaignId [KEY] String The unique ID for the campaign.`
Id [KEY] String The ID for the specific item.
Type String The item type. The allowed values are success, warning, error.
Heading String The heading for the specific item.
Details String Details about the specific feedback item.

CampaignVariateContents

Get the the HTML and plain-text content for a campaign.

Table Specific Information
Select

The connector 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 connector.

The CamapignId can be retrieved by selecting the Campaigns table.

  • CamapaignId supports the = operator.

For example:

SELECT * FROM CampaignVariateContents;
SELECT * FROM CampaignVariateContents where CampaignId='381b6f0c90';
Columns
Name Type Description
CampaignId String The unique ID for the campaign.
ContentLabel String Label used to identify the content option.
PlainText String The plain-text portion of the campaign. If left unspecified, we'll generate this automatically.
Html String The raw HTML for the campaign.

ChimpChatterActivity

Return the Chimp Chatter for this account ordered by most recent.

Table Specific Information

SELECT is supported for ChimpChatterActivity.

Select
SELECT * FROM ChimpChatterActivity
Columns
Name Type Description
Title String A string that uniquely identifies this batch request.
Message String The plain-text portion of the campaign. If left unspecified, we'll generate this automatically.
Type String The raw HTML for the campaign. The allowed values are lists:new-subscriber, lists:unsubscribes, lists:profile-updates, campaigns:facebook-likes, campaigns:forward-to-friend, lists:imports.
ModifiedAt Datetime The Archive HTML for the campaign.
Url String A list of link types and descriptions for the API schema documents.
ListId String A string that uniquely identifies this batch request.
CamapignId String A string that uniquely identifies this batch request.

ConnectedSites

Get all connected sites in an account.

Table Specific Information
Select

The connector 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 connector.

  • Id supports the = operator.

For example:

SELECT * FROM ConnectedSites;
SELECT * FROM ConnectedSites where Id='03008bc4e0f0';
Columns
Name Type Description
Id [KEY] String The unique identifier for the site.
StoreId String The unique identifier for the ecommerce store that's associated with the connected site (if any). The store_id for a specific connected site can't change.
Platform String The platform of the connected site.
Domain String The connected site domain.
CreatedAt Datetime The date and time the connected site was created in ISO 8601 format.
UpdatedAt Datetime The date and time the connected site was last updated in ISO 8601 format.
SiteScriptUrl String The URL used for any integrations that offer built-in support for connected sites.
SiteScriptFragment String A pre-built script that you can copy-and-paste into your site to integrate it with Mailchimp.
Links String A list of link types and descriptions for the API schema documents.

ConversationMessages

Messages from a specific conversation. Conversation tracking is a feature available to paid accounts that lets you view replies to your campaigns from inside your Mailchimp account.

Table Specific Information
Select

The connector 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 connector.

  • Id supports the = operator.
  • ConversationId supports the = operator.
  • Read supports the = operator.
  • Timestamp supports the =, <, >, <=, and >= operators.
Select
SELECT * FROM ConversationMessages
SELECT * FROM ConversationMessages WHERE ConversationId = '1245' and Id='1254'
SELECT * FROM ConversationMessages WHERE Read = true
SELECT * FROM ConversationMessages WHERE Timestamp = '2024-02-07 00:00:37.0'
SELECT * FROM ConversationMessages WHERE Timestamp >= '2024-02-07 00:00:37.0'
SELECT * FROM ConversationMessages WHERE Timestamp <= '2024-02-07 00:00:37.0'
SELECT * FROM ConversationMessages WHERE Timestamp > '2024-02-07 00:00:37.0'
SELECT * FROM ConversationMessages WHERE Timestamp < '2024-02-07 00:00:37.0'
Columns
Name Type Description
Id [KEY] String A string that uniquely identifies this message
ConversationId [KEY] String A string that identifies this message's conversation
ListId [KEY] String The unique identifier of the list this conversation is associated with
FromLabel String A label representing the sender of this message
FromEmail String A label representing the email of the sender of this message
Subject String The subject of this message
Message String The plain-text content of the message
Read Boolean Whether or not this message has been marked as read
Timestamp Datetime Date the message was either sent or received

Conversations

A collection of this account's tracked conversations. Conversation tracking is a feature available to paid accounts that lets you view replies to your campaigns from inside your Mailchimp account.

Table Specific Information
Select

The connector 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 connector.

  • Id supports the = operator.
  • CampaignId supports the = operator.
  • ListId supports the = operator.
  • HasUnreadMessages supports the = operator.
Select
SELECT * FROM Conversations WHERE Id = '1254'
SELECT * FROM Conversations WHERE CampaignId = '1245'
SELECT * FROM Conversations WHERE ListId = '1245'
SELECT * FROM Conversations WHERE HasUnreadMessages = 'true'
Columns
Name Type Description
Id [KEY] String A string that uniquely identifies this conversation
MessageCount Integer The total number of messages in this conversation
CampaignId [KEY] String The unique identifier of the campaign this conversation is associated with
ListId [KEY] String The unique identifier of the list this conversation is associated with
UnreadMessages Integer The number of unread messages in this conversation
FromLabel String A label representing the sender of this message
FromEmail String A label representing the email of the sender of this message
Subject String The subject of the message
LastMessage_FromLabel String A label representing the sender of this message
LastMessage_FromEmail String A label representing the email of the sender of this message
LastMessage_Subject String The subject of this message
LastMessage_Message String The plain-text content of the message
LastMessage_Read Boolean Whether or not this message has been marked as read
LastMessage_Timestamp Datetime Date the message was either sent or received
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
HasUnreadMessages String Filter on unread_messages, only valid for SELECT.

EcommerceProductImages

A Product Image represents a specific product image.

Table Specific Information
Select

The connector 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 connector.

The StoreId can be retrieved by selecting the EcommerceStores view and ProductId can be retrieved by selecting the EcommerceProducts table.

  • StoreId supports the = operator.
  • ProductId supports the = operator.
  • Id supports the = operator.

For example:

SELECT * FROM EcommerceProductImages;
SELECT * FROM EcommerceProductImages where Id='Test_Images';
SELECT * FROM EcommerceProductImages where ProductId='1233' and StoreId='STR002';
SELECT * FROM EcommerceProductImages where Id='Test_Images1' and ProductId='1233' and StoreId='STR002';
Columns
Name Type Description
StoreId [KEY] String The ID for the store.
ProductId [KEY] String The ID of the associated product.
Id [KEY] String A unique identifier for the product image.
Url String The actual promotional code.
VariantIds String URL used to redeem the promo code.
Links String A list of link types and descriptions for the API schema documents.

EcommercePromoCodes

Retrieves the list of promo codes under a promo rule

Table Specific Information
Select

The connector 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 connector.

The StoreId can be retrieved by selecting the EcommerceStores view and PromoRuleId can be retrieved by selecting the PromoRules view.

  • StoreId supports the = operator.
  • PromoRuleId supports the = operator.
  • Id supports the = operator.

For example:

SELECT * FROM EcommercePromoCodes;
SELECT * FROM EcommercePromoCodes where Id='test_promorule2';
SELECT * FROM EcommercePromoCodes where PromoRuleId='test_promorule2' and storeId='YM_Store';
SELECT * FROM EcommercePromoCodes where PromoRuleId='test_promorule2' and storeId='YM_Store' and Id='test_promorule2';
Columns
Name Type Description
StoreId [KEY] String The ID for store.
PromoRuleId [KEY] String The ID of the associated promo rule.
Id [KEY] String The unique identifier of the promo code.
Code String The actual promotional code.
RedemptionUrl String URL used to redeem the promo code.
UsageCount Integer Number of times the code has been used.
Enabled Boolean Number of times the code has been used.
CreatedAtForeign Datetime The date and time the promotion was created in ISO 8601 format.
UpdatedAtForeign Datetime The date and time the promotion was updated in ISO 8601 format.
Links String A list of link types and descriptions for the API schema documents.

EcommercePromoRules

Get information about a store's promo rules

Table Specific Information
Select

The connector 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 connector.

The StoreId can be retrieved by selecting the EcommerceStores view.

  • StoreId supports the = operator.
  • Id supports the = operator.

For example:

SELECT * FROM EcommercePromoRules;
SELECT * FROM EcommercePromoRules where where Id='ruleid1'
SELECT * FROM EcommercePromoRules where Id='ruleid1' and storeId='STR002';
Columns
Name Type Description
StoreId [KEY] String The Store Id.
Id [KEY] String The ID of the associated promo rule.
Ttile String The title that will show up in promotion campaign.
Description String The description of a promotion restricted to UTF-8 characters with max length 255.
StartsAt Datetime The date and time when the promotion is in effect in ISO 8601 format.
EndsAt Datetime The date and time when the promotion ends. Must be after starts_at and in ISO 8601 format.
Amount Decimal The amount of the promo code discount. If 'type' is 'fixed', the amount is treated as a monetary value. If 'type' is 'percentage', amount must be a decimal value between 0.0 and 1.0, inclusive
Type String Type of discount. For free shipping set type to fixed. The allowed values are fixed, percentage.
Target String The target that the discount applies to. The allowed values are per_item, total, shipping.
Enabled Boolean Whether the promo rule is currently enabled.
CreatedAtForeign Datetime The date and time the promotion was created in ISO 8601 format.
UpdatedAtForeign Datetime The date and time the promotion was updated in ISO 8601 format.
Links String A list of link types and descriptions for the API schema documents.

EcommerceStores

A list of an account's ecommerce stores.

Table Specific Information
Select

The connector 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 connector.

  • Id supports the = operator.

For example:

SELECT * FROM EcommerceStores WHERE  ID = '44'
Columns
Name Type Description
Id [KEY] String The unique identifier for the store.
ListId [KEY] String The unique identifier for the Mailchimp list that's associated with the store. The list_id for a specific store can't change.
Name String The name of the store.
Platform String The ecommerce platform of the store.
Domain String The store domain.
EmailAddress String The email address for the store.
CurrencyCode String The three-letter ISO 4217 code for the currency that the store accepts.
MoneyFormat String The currency format for the store. For example: `$`, etc.
PrimaryLocale String The primary locale for the store. For example: `en`, `de`, etc.
Timezone String The timezone for the store.
Phone String The store phone number.
Address_Address1 String The store's mailing address.
Address_Address2 String An additional field for the store's mailing address.
Address_City String The city the store is located in.
Address_Province String The store's state name or normalized province.
Address_ProvinceCode String The two-letter code for the store's province or state.
Address_PostalCode String The store's postal or zip code.
Address_Country String The store's country.
Address_CountryCode String The two-letter code for to the store's country.
Address_Longitude Double The longitude of the store location.
Address_Latitude Double The latitude of the store location.
CreatedAt Datetime The date and time the store was created.
UpdatedAt Datetime The date and time the store was last updated.
IsSyncing Boolean Whether to disable automations because the store is currently syncing.
ConnectedSite_SiteForeignId String The unique identifier for the connected site.
ConnectedSite_SiteScript_Url String The URL used for any integrations that offer built-in support for connected sites.
ConnectedSite_SiteScript_Fragment String A pre-built script that you can copy-and-paste into your site to integrate it with Mailchimp.
Automations_AbandondedCart_IsSupported Boolean Whether this store supports the abandonedCart automation.
Automations_AbandondedCart_Id String Unique ID of automation parent campaign.
Automations_AbandondedCart_Status String Status of the abandonedCart automation. The allowed values are save, sending, paused.
Automations_AbandondedBrowse_IsSupported Boolean Whether this store supports the abandonedBrowse automation.
Automations_AbandondedBrowse_Id String Unique ID of automation parent campaign.
Automations_AbandondedBrowse_Status String Status of the abandonedBrowse automation. The allowed values are save, sending, paused.
ListIsActive Boolean The status of the list connected to the store, namely if it's deleted or disabled.

ListAbuse

A collection of abuse complaints for a specific list. An abuse complaint occurs when your recipient clicks to 'report spam' in their email program.

Table Specific Information
Select

The connector 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 connector.

  • Id supports the = operator.
  • ListId supports the = operator.
SELECT * FROM ListAbuse WHERE ListId = 'abc' and Id='452'
Columns
Name Type Description
Id [KEY] String The ID for the abuse report
CampaignId [KEY] String The campaign ID for the abuse report
ListId [KEY] String The list ID for the abuse report.
EmailId [KEY] String The MD5 hash of the list member's email address.
EmailAddress String Email address for a subscriber
Date String Date for the abuse report
MergeFields String A dictionary of merge fields where the keys are the merge tags. See the Merge Fields documentation for more about the structure.
VIP Boolean VIP status for subscriber.

ListActivity

Up to the previous 180 days of daily detailed aggregated activity stats for a given list. Does not include AutoResponder or Automation activity.

Table Specific Information
Select

The connector 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 connector.

  • ListId supports the = operator.
SELECT * FROM ListActivity WHERE ListId = 'abc'
Columns
Name Type Description
ListId [KEY] String The ListId for the table.
Day [KEY] Date The date for the activity summary.
EmailsSent Integer The total number of emails sent on the date for the activity summary.
UniqueOpens Integer The number of unique opens.
RecipientClicks Integer The number of clicks.
HardBounce Integer The number of hard bounces.
SoftBounce Integer The number of soft bounces
Subs Integer The number of subscribes.
Unsubs Integer The number of unsubscribes.
OtherAdds Integer The number of subscribers who may have been added outside of the double opt-in process such as imports or API activity.
OtherRemoves Integer The number of subscribers who may have been removed outside of unsubscribing or reporting an email as spam. For example, deleted subscribers.

ListClients

Top email clients used, as measured by their user-agent string

Table Specific Information
Select

The connector 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 connector.

  • ListId supports the = operator.
SELECT * FROM ListClients WHERE ListId = 'abc'
Columns
Name Type Description
Client String The name of the email client.
Members Integer The number of subscribed members who used this email client.
ListId [KEY] String The unique ID for the list.

ListGrowthHistory

A month-by-month summary of a specific list's growth activity.

Table Specific Information
Select

The connector 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 connector.

  • ListId supports the = operator.
SELECT * FROM ListGrowthHistory WHERE ListId = 'abc'
Columns
Name Type Description
ListId [KEY] String The list ID for the growth activity report.
Month [KEY] String The month that the growth history is describing.
Subscribed Integer Total subscribed members on the list at the end of the month.
Unsubscribed Integer Newly unsubscribed members on the list for a specific month.
Reconfirm Integer Newly reconfirmed members on the list for a specific month.
Cleaned Integer Newly cleaned (hard-bounced) members on the list for a specific month.
Pending Integer Pending members on the list for a specific month.
Deleted Integer Newly deleted members on the list for a specific month.
Transactional Integer Subscribers that have been sent transactional emails via Mandrill.

ListMemberActivity

The last 50 member events for a list.

Table Specific Information
Select

The connector 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 connector.

  • MemberId supports the = operator.
  • ListId supports the = operator.
  • Action supports the =, and IN operators.
SELECT * FROM ListMemberActivity where ListId='121' and Action IN ('open', 'sent') and MemberId = '1211'
Columns
Name Type Description
MemberId String The MemberId of the member to get events for.
EmailId String The EmailId for the table.
ListId String The ListId for the table.
Action String The type of action recorded for the subscriber.
Timestamp Datetime The date and time recorded for the action.
Url String For clicks, the URL the subscriber clicked on.
Type String The type of campaign that was sent.
CampaignId String The web-based ID for the campaign.
Title String If set, the campaign's title.
ParentCampaign String The ID of the parent campaign.
ContactId String The ID of the contact.

ListMemberTags

Tags assigned to a certain member/members.

Table Specific Information
Select

The connector 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 connector.

  • Id supports the = operator.
  • ListId supports the = operator.
  • MemberId supports the = operator.
SELECT * FROM ListMemberTags WHERE ListId = '12345' and MemberId = '458' and ID = '45';
Columns
Name Type Description
Id [KEY] String The unique ID of the tag.
Name String Name of the tag. When inserting, if the name doesn't exist, it will be created and then assigned to the member specified.
TimeAdded Datetime Date and time the tag was added to the member.
ListId [KEY] String The ID of the list on which the member of this tag belongs to.
MemberId [KEY] String The ID of the member this tag is assigned to.

ListSignupForms

Collection of List Signup Forms

Table Specific Information
Select

The connector 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 connector.

  • ListId supports the = operator.
SELECT * FROM ListSignupForms WHERE ListId = 'abc'
Columns
Name Type Description
Header_ImageUrl String Header Image Url
Header_Text String Header Text
Header_ImageWidth String Image width
Header_ImageHeight String Image height
Header_ImageAlt String Image Alt
Header_ImageLink String Image Link
Header_ImageAlign String Image align
Header_ImageBorderWidth String Image border width
Header_ImageBorderStyle String Image border style
Header_ImageBorderColor String Image border color
Header_ImageTarget String Image target
Contents String Signup form body contents options
Styles String An array of objects, each representing each element of signup forms.
SignupFormUrl String Signup form URL
ListId [KEY] String A string that identifies this signup forms' list.

ReportAbuse

A list of abuse complaints for a specific list.

Table Specific Information

SELECT is supported for ReportAbuse.

Select

The connector 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 connector.

  • Id supports the = operator.
  • CampaignId supports the = operator.
SELECT * FROM ReportAdvice WHERE CampaignId = 'abc' and ID = '556'
Columns
Name Type Description
Id [KEY] String The unique ID for the abuse report.
CampaignId [KEY] String The campaign ID for the abuse report
ListId [KEY] String The list ID for the abuse report.
EmailId [KEY] String The list-specific ID for the given email address
EmailAddress String Email address for a subscriber
Date String Date for the abuse report
MergeFields String A dictionary of merge fields where the keys are the merge tags. See the Merge Fields documentation for more about the structure.
VIP Boolean VIP status for subscriber.
ListIsActive Boolean The status of the list used, namely if it's deleted or disabled.

ReportAdvice

A list of feedback based on a campaign's statistics.

Table Specific Information

SELECT is supported for ReportAdvice.

Select

The connector 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 connector.

  • CampaignId supports the = operator.
SELECT * FROM ReportAdvice WHERE CampaignId = 'abc'
Columns
Name Type Description
CampaignId String The CampaignId for the table.
Type String The 'type' of message ('negative', 'positive', 'neutral').
Message String The advice message.

ReportClickDetails

A list of URLs and unique IDs included in HTML and plain-text versions of a campaign.

Table Specific Information

SELECT is supported for ReportClickDetails.

Select

The connector 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 connector.

  • Id supports the = operator.
  • CampaignId supports the = operator.
SELECT * FROM ReportClickDetails WHERE CampaignId = 'abc' and ID = '5659'
Columns
Name Type Description
Id [KEY] String
Url String The URL for the link in the campaign.
TotalClicks Integer The number of total clicks for a given link.
ClickPercentage Double The percentage of total clicks a given link generated for a campaign.
UniqueClicks Integer Number of unique clicks for a given link.
UniqueClickPercentage Double The percentage of unique clicks a given link generated for a campaign.
LastClick Datetime The date and time for the last recorded click for a given link.
AbSplit_A String
AbSplit_B String
CampaignId [KEY] String The ID for the campaign.

ReportClickDetailsMembers

A collection of members who clicked on a specific link within a campaign.

Table Specific Information

SELECT is supported for ReportClickDetailsMembers.

Select

The connector 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 connector.

  • EmailId supports the = operator.
  • CampaignId supports the = operator.
  • UrlId supports the = operator.
SELECT * FROM ReportClickDetailsMembers WHERE EmailId = '12a32' and CampaignId = '123d' and URLId = '3241s'
Columns
Name Type Description
EmailId [KEY] String The list-specific ID for the given email address.
EmailAddress String Email address for a subscriber
Clicks Integer The total number of times the subscriber clicked on the link.
CampaignId [KEY] String The ID for the campaign.
UrlId [KEY] String The ID for the tracked URL in the campaign.
ListId [KEY] String The ID for the list.
ListIsActive Boolean The status of the list used, namely if it's deleted or disabled.
ContactStatus String The status of the member, namely if they are subscribed, unsubscribed, deleted, non-subscribed, transactional, pending, or need reconfirmation.
MergeFields String A dictionary of merge fields where the keys are the merge tags. See the Merge Fields documentation for more about the structure.
VIP Boolean VIP status for subscriber.

ReportDomainPerformance

Statistics for the top-performing email domains in a campaign.

Table Specific Information

SELECT is supported for ReportDomainPerformance.

Select

The connector 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 connector.

  • CampaignId supports the = operator.
SELECT * FROM ReportDomainPerformance WHERE CampaignId = 'abc'
Columns
Name Type Description
CampaignId String The CampaignId for the table.
Domain String The name of the domain (gmail.com, hotmail.com, yahoo.com).
EmailsSent Integer The number of emails sent to that specific domain.
Bounces Integer The number of bounces at a domain.
Opens Integer The number of opens for a domain.
Clicks Integer The number of clicks for a domain.
Unsubs Integer The total number of unsubscribes for a domain.
Delivered Integer The number of successful deliveries for a domain.
EmailsPct Double The percentage of total emails that went to this domain.
BouncesPct Double The percentage of total bounces that came from this domain.
OpensPct Double The percentage of total opens that came from this domain.
ClicksPct Double The percentage of total clicks tht came from this domain.
UnsubsPct Double The percentage of total unsubscribes taht came from this domain.

ReportEmailActivity

A list of member's subscriber activity in a specific campaign.

Table Specific Information

SELECT is supported for ReportEmailActivity.

Select

The connector 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 connector.

  • CampaignId supports the = operator.
SELECT * FROM ReportEmailActivity where CampaignId = '45a'
Columns
Name Type Description
CampaignId [KEY] String The unique ID for the campaign.
ListId [KEY] String The unique ID for the list.
EmailId [KEY] String The list-specific ID for the given email address.
EmailAddress String Email address for a subscriber
Activity String An array of objects, each showing an interaction with the email.
ListIsActive Boolean The status of the list used, namely if it's deleted or disabled.

ReportLocations

Top open locations for a specific campaign.

Table Specific Information

SELECT is supported for ReportLocations.

Select

The connector 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 connector.

  • CampaignId supports the = operator.
SELECT * FROM ReportLocations where CampaignId = '45a'
Columns
Name Type Description
CampaignId [KEY] String The CampaignId for the table.
Region [KEY] String A more specific location area such as city or state.
Opens Integer The number of unique campaign opens for a given region.
CountryCode String The ISO 3166 2 digit country code.
RegionName String The name of the region, if we have one. For blank 'region' values, this will be 'Rest of Country'.

Reports

A list of reports containing campaigns marked as Sent.

Table Specific Information

SELECT is supported for Reports.

Select

The connector 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 connector.

  • Id supports the = operator.
  • Type supports the = operator.
  • SendTime supports the =, <, >, <=, and >= operators.
SELECT * FROM Reports where Id = '45a'
SELECT * FROM Reports where Type = 'regular'
SELECT * FROM Reports WHERE SendTime = '2024-02-07 00:00:37.0'
SELECT * FROM Reports WHERE SendTime >= '2024-02-07 00:00:37.0'
SELECT * FROM Reports WHERE SendTime <= '2024-02-07 00:00:37.0'
SELECT * FROM Reports WHERE SendTime > '2024-02-07 00:00:37.0'
SELECT * FROM Reports WHERE SendTime < '2024-02-07 00:00:37.0'
Columns
Name Type Description
Id [KEY] String A string that uniquely identifies this campaign.
CampaignTitle String The title of the campaign.
Type String The type of campaign (regular, plain-text, ab_split, rss, automation, variate, or auto).
EmailsSent Integer The total number of emails sent for this campaign.
AbuseReports Integer The number of abuse reports generated for this campaign.
Unsubscribed Integer The total number of unsubscribed members for this campaign.
SendTime Datetime The time and date a campaign was sent.
Bounces_HardBounces Integer The total number of hard bounced email addresses.
Bounces_SoftBounces Integer The total number of soft bounced email addresses.
Bounces_SyntaxErrors Integer The total number of addresses that were syntax-related bounces.
Forwards_ForwardsCount Integer
Forwards_ForwardsOpens Integer
Opens_OpensTotal Integer The total number of opens for a campaign.
Opens_UniqueOpens Integer The total number of unique subscribers who opened a campaign.
Opens_OpenRate Double The number of unique subscribers who opened divided by the total number of successful deliveries.
Opens_LastOpen Datetime The date and time of the last recorded open.
Clicks_ClicksTotal Integer The total number of clicks for the campaign.
Clicks_UniqueClicks Integer The total number of unique clicks for links across a campaign.
Clicks_UniqueSubscriberClicks Integer The total number of subscribers who clicked on a campaign.
Clicks_ClickRate Double The number of unique subscribers who clicked divided by the total number of successful deliveries.
Clicks_LastClick Datetime The date and time of the last recorded click for the campaign.
FacebookLikes_RecipientLikes Integer
FacebookLikes_UniqueLikes Integer
FacebookLikes_FacebookLikes Integer
IndustryStats_Type String
IndustryStats_OpenRate Double
IndustryStats_ClickRate Double
IndustryStats_BounceRate Double
IndustryStats_UnopenRate Double
IndustryStats_UnsubRate Double
IndustryStats_AbuseRate Double
ListStats_SubRate Double The average number of subscriptions per month for the list.
ListStats_UnsubRate Double The average number of unsubscriptions per month for the list.
ListStats_OpenRate Double The average open rate (a percentage represented as a number between 0 and 100) per campaign for the list.
ListStats_ClickRate Double The average click rate (a percentage represented as a number between 0 and 100) per campaign for the list.
AbSplit_A String
AbSplit_B String
Timewarp String An hourly breakdown of sends, opens, and clicks if a campaign is sent using timewarp.
Timeseries String An hourly breakdown of the performance of the campaign over the first 24 hours.
ShareReport_ShareUrl String The URL for the VIP report.
ShareReport_SharePassword String If password protected, the password for the VIP report.
DeliveryStatus String Updates on campaigns in the process of sending.
ListId String The unique list id.
ListIsActive Boolean The status of the list used, namely if it's deleted or disabled.
ListName String The name of the list.
SubjectLine String The subject line for the campaign.
PreviewText String The preview text for the campaign.
RssLastSend String For RSS campaigns, the date and time of the last send in ISO 8601 format.
Ecommerce String E-Commerce stats for a campaign.

ReportSentTo

A list of subscribers who were sent a specific campaign.

Table Specific Information
Select

The connector 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 connector.

  • EmailId supports the = operator.
  • CampaignId supports the = operator.
SELECT * FROM ReportSentTo where EmailId = '45a' and CampaignId = '458'
Columns
Name Type Description
EmailId [KEY] String The list-specific ID for the given email address.
EmailAddress String Email address for a subscriber.
Status String The status of the member ('sent', 'hard' for hard bounce, or 'soft' for soft bounce).
OpenCount Integer The number of times a campaign was opened by this member.
LastOpen String The date and time of the last open for this member.
AbsplitGroup String For A/B Split Campaigns, the group the member was apart of ('a', 'b', or 'winner').
GmtOffset Integer For campaigns sent with timewarp, the time zone group the member is apart of.
CampaignId [KEY] String The ID for the campaign.
ListId [KEY] String The ID for the list.
ListIsActive Boolean The status of the list used, namely if it's deleted or disabled.
MergeFields String A dictionary of merge fields where the keys are the merge tags. See the Merge Fields documentation for more about the structure.
VIP Boolean VIP status for subscriber.

ReportUnsubscribes

A list of members who have unsubscribed from a specific campaign.

Table Specific Information

SELECT is supported for ReportUnsubscribes.

Table Specific Information
Select

The connector 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 connector.

  • EmailId supports the = operator.
  • CampaignId supports the = operator.
SELECT * FROM ReportUnsubscribes where EmailId = '45a' and CampaignId = '458'
Columns
Name Type Description
EmailId [KEY] String The list-specific ID for the given email address
EmailAddress String Email address for a subscriber
Timestamp Datetime The date and time the member opted-out.
Reason String If available, the reason listed by the member for unsubscribing.
CampaignId [KEY] String The ID for the campaign.
ListId [KEY] String The ID for the list.
ListIsActive Boolean The status of the list used, namely if it's deleted or disabled.
MergeFields String A dictionary of merge fields where the keys are the merge tags. See the Merge Fields documentation for more about the structure.
VIP Boolean VIP status for subscriber.

SurveyResponses

List of survey responses.

Table Specific Information

SELECT is supported for SurveyResponses.

Select

The connector 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 connector.

  • Id supports the = operator.
  • SurveyId supports the = operator.
  • AnsweredQuestion supports the = operator.
  • ChoseAnswer supports the = operator.
  • RespondentFamiliarityIs supports the = operator.
SELECT * FROM SurveyResponses WHERE SurveyId = '4548' and Id = '5995'
SELECT * FROM SurveyResponses WHERE SurveyId = '4548' and AnsweredQuestion = '81215a'
SELECT * FROM SurveyResponses WHERE SurveyId = '4548' and ChoseAnswer = '81215a'
SELECT * FROM SurveyResponses WHERE SurveyId = '4548' and RespondentFamiliarityIs = 'new'
Columns
Name Type Description
Id [KEY] String The ID for the survey response.
SubmittedAt Datetime The date and time when the survey response was submitted.
ContactEmailId String The MD5 hash of the lowercase version of the list member email address.
ContactId String The ID of this contact.
ContactStatus String The contact's current status.
ContactEmail String The contact's email address.
ContactFullName String The contact's full name.
ContactConsentsToOneToOneMessaging Boolean Indicates whether a contact consents to 1:1 messaging.
ContactAvatarUrl String URL for the contact's avatar or profile image.
IsNewContact Boolean If this contact was added to the Mailchimp audience via this survey.
SurveyId [KEY] String A string that uniquely identifies this survey.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
AnsweredQuestion Integer The ID of the question that was answered.
ChoseAnswer String The ID of the option chosen to filter responses on.
RespondentFamiliarityIs String Filter survey responses by familiarity of the respondents. Possible values: 'new', 'known', or 'unknown'

Surveys

Get reports for surveys.

Table Specific Information
Select

The connector 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 connector.

  • Id supports the = operator.
SELECT * FROM Surveys WHERE ID = '1245'
Columns
Name Type Description
Id [KEY] String A string that uniquely identifies this survey.
WebId Integer The ID used in the Mailchimp web application.
ListId String The ID of the list connected to this survey.
ListName String The name of the list connected to this survey.
Title String The title of the survey.
Url String The URL for the survey.
Status String The status of the Surney. Possible values: published or unpublished.
PublishedAt Datetime The date and time the survey was published.
CreatedAt Datetime The date and time the survey was created.
UpdatedAt Datetime The date and time the survey was last updated.
TotalResponses Integer The total number of responses to this survey.

TransactionalScheduledEmails

Get Transactional Scheduled Emails.

Table Specific Information

Only SELECT is supported for TransactionalScheduledEmails.

Select

The connector 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 connector.

  • To supports the = operator.
SELECT * FROM TransactionalScheduledEmails WHERE To = 'recipient@example.com'
Columns
Name Type Description
Id [KEY] String The scheduled message id.
CreatedAt Datetime The UTC timestamp when the message was created, in YYYY-MM-DD HH:MM:SS format.
SendAt Datetime The UTC timestamp when the message will be sent, in YYYY-MM-DD HH:MM:SS format.
FromEmail String The email's sender address.
To String The email's recipient.
Subject String The email's subject.

TransactionalSenders

Get Transactional Senders.

Table Specific Information

Only SELECT is supported for TransactionalSenders.

Select

The connector 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 connector.

  • Address supports the = operator.
SELECT * FROM TransactionalSenders WHERE Address = 'sender@example.com'
Columns
Name Type Description
Address String The sender's email address.
CreatedAt Datetime The date and time that the sender was first seen by Mandrill as a UTC date string in YYYY-MM-DD HH:MM:SS format
Sent Integer The total number of messages sent by this sender.
HardBounces Integer The total number of hard bounces by messages by this sender.
SoftBounces Integer The total number of soft bounces by messages by this sender.
Rejects Integer The total number of rejected messages by this sender.
Complaints Integer The total number of spam complaints received for messages by this sender.
Unsubs Integer The total number of unsubscribe requests received for messages by this sender.
Opens Integer The total number of times messages by this sender have been opened.
Clicks Integer The total number of times tracked URLs in messages by this sender have been clicked.
UniqueOpens Integer The number of unique opens for emails sent for this sender.
UniqueClicks Integer The number of unique clicks for emails sent for this sender.

TransactionalUserInfos

Get Transactional user info.

Table Specific Information

Only SELECT is supported for TransactionalUserInfos.

Select

There are filters supported server side for this view. This view will provide the details of current user.

SELECT * FROM TransactionalUserInfos
Columns
Name Type Description
UserName String The username of the user (used for SMTP authentication).
CreatedAt Datetime The date and time that the user's Mandrill account was created as a UTC string in YYYY-MM-DD HH:MM:SS format.
PublicId String A unique, permanent identifier for this user.
Reputation Integer The reputation of the user on a scale from 0 to 100.
HourlyQuota Integer The maximum number of emails Mandrill will deliver for this user each hour.
Backlog Integer The number of emails that are queued for delivery due to exceeding your monthly or hourly quotas.
StatsTodaySent Integer The number of emails sent so far today.
StatsTodayHardBounces Integer The number of emails that hard bounced so far today.
StatsTodaySoftBounces Integer The number of emails that soft bounced so far today.
StatsTodayRejects Integer The number of emails rejected for sending so far today.
StatsTodayComplaints Integer The number of spam complaints received so far today.
StatsTodayUnsubs Integer The number of unsubscribes received so far today.
StatsTodayOpens Integer The number of times emails have been opened so far today.
StatsTodayClicks Integer The number of URLs that have been clicked so far today.
StatsTodayUniqueOpens Integer The number of unique opens so far today.
StatsTodayUniqueClicks Integer The number of unique clicks so far today.
StatsLast7DaysSent Integer The number of emails sent in the last 7 days.
StatsLast7DaysHardBounces Integer The number of hard bounces in the last 7 days.
StatsLast7DaysSoftBounces Integer The number of soft bounces in the last 7 days.
StatsLast7DaysRejects Integer The number of rejected emails in the last 7 days.
StatsLast7DaysComplaints Integer The number of spam complaints in the last 7 days.
StatsLast7DaysUnsubs Integer The number of unsubscribes in the last 7 days.
StatsLast7DaysOpens Integer The number of opens in the last 7 days.
StatsLast7DaysClicks Integer The number of clicks in the last 7 days.
StatsLast7DaysUniqueOpens Integer The number of unique opens in the last 7 days.
StatsLast7DaysUniqueClicks Integer The number of unique clicks in the last 7 days.
StatsLast30DaysSent Integer The number of emails sent in the last 30 days.
StatsLast30DaysHardBounces Integer The number of hard bounces in the last 30 days.
StatsLast30DaysSoftBounces Integer The number of soft bounces in the last 30 days.
StatsLast30DaysRejects Integer The number of rejected emails in the last 30 days.
StatsLast30DaysComplaints Integer The number of spam complaints in the last 30 days.
StatsLast30DaysUnsubs Integer The number of unsubscribes in the last 30 days.
StatsLast30DaysOpens Integer The number of times emails have been opened in the last 30 days.
StatsLast30DaysClicks Integer The number of URLs that have been clicked in the last 30 days.
StatsLast30DaysUniqueOpens Integer The number of unique opens in the last 30 days.
StatsLast30DaysUniqueClicks Integer The number of unique clicks in the last 30 days.
StatsLast60DaysSent Integer The number of emails sent in the last 60 days.
StatsLast60DaysHardBounces Integer The number of hard bounces in the last 60 days.
StatsLast60DaysSoftBounces Integer The number of soft bounces in the last 60 days.
StatsLast60DaysRejects Integer The number of rejected emails in the last 60 days.
StatsLast60DaysComplaints Integer The number of spam complaints in the last 60 days.
StatsLast60DaysUnsubs Integer The number of unsubscribes in the last 60 days.
StatsLast60DaysOpens Integer The number of times emails have been opened in the last 60 days.
StatsLast60DaysClicks Integer The number of URLs that have been clicked in the last 60 days.
StatsLast60DaysUniqueOpens Integer The number of unique opens in the last 60 days.
StatsLast60DaysUniqueClicks Integer The number of unique clicks in the last 60 days.
StatsLast90DaysSent Integer The number of emails sent in the last 90 days.
StatsLast90DaysHardBounces Integer The number of hard bounces in the last 90 days.
StatsLast90DaysSoftBounces Integer The number of soft bounces in the last 90 days.
StatsLast90DaysRejects Integer The number of rejected emails in the last 90 days.
StatsLast90DaysComplaints Integer The number of spam complaints in the last 90 days.
StatsLast90DaysUnsubs Integer The number of unsubscribes in the last 90 days.
StatsLast90DaysOpens Integer The number of times emails have been opened in the last 90 days.
StatsLast90DaysClicks Integer The number of URLs that have been clicked in the last 90 days.
StatsLast90DaysUniqueOpens Integer The number of unique opens in the last 90 days.
StatsLast90DaysUniqueClicks Integer The number of unique clicks in the last 90 days.
StatsLastAllTimeDaysSent Integer The total number of emails sent through the account.
StatsLastAllTimeDaysHardBounces Integer The total number of hard bounces for the account.
StatsLastAllTimeDaysSoftBounces Integer The total number of soft bounces for the account.
StatsLastAllTimeDaysRejects Integer The total number of rejected emails for the account.
StatsLastAllTimeDaysComplaints Integer The total number of spam complaints for the account.
StatsLastAllTimeDaysUnsubs Integer The total number of unsubscribes for the account.
StatsLastAllTimeDaysOpens Integer The total number of times emails have been opened for the account.
StatsLastAllTimeDaysClicks Integer The total number of URLs that have been clicked for the account.
StatsLastAllTimeDaysUniqueOpens Integer The total number of unique opens for the account.
StatsLastAllTimeDaysUniqueClicks Integer The total number of unique clicks for the account.

Stored Procedures

Stored procedures are function-like interfaces that extend the functionality of the connector beyond simple SELECT/INSERT/UPDATE/DELETE operations with Mailchimp.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Mailchimp, along with an indication of whether the procedure succeeded or failed.

Mailchimp Connector Stored Procedures

Name Description
AddOrRemoveMemberTags Adds or removes tags from a list member. If a tag that does not exist is provided and marked as 'active', a new tag is created.
AddSubscriberToWorkflowEmail Manually add a subscriber to a workflow, bypassing the default trigger settings.
CampaignCancel Cancels a Mailchimp Regular or Plain-Text campaign.
CampaignPause Pauses a Mailchimp RSS campaign.
CampaignResume Resumes a Mailchimp RSS campaign.
CampaignSchedule Schedules a Mailchimp campaign. Either Timewarp or the batch properties can be used, not both.
CampaignSend Sends a Mailchimp campaign.
CampaignTest Sends a test email for a Mailchimp campaign.
CampaignUnschedule Unschedules a Mailchimp campaign.
DeleteECommerceCarts Deletes the ECommerceCart.
GetOAuthAccessToken Obtains the OAuth access token to be used for authentication with MailChimp.
GetOAuthAuthorizationURL Obtains the OAuth authorization URL used for authentication with MailChimp.
RemoveSubscriberFromWorkflow Remove a subscriber from a specific classic automation workflow. You can remove a subscriber at any point in an automation workflow, regardless of how many emails they've sent from that workflow. Once you remove a subscriber, you cannot add them back to the same workflow.
TransactionalCancelScheduledEmail Cancels a scheduled email.
TransactionalRescheduledEmail Reschedules a scheduled email.
TransactionalSendMessage Send a new transactional message through the Transactional API.
TransactionalSendTemplate Send a new transactional message through the Transactional API using a template.
UpdateECommerceCarts Updates the ECommerceCart. To update lines in ECommerceCarts, please use UPDATE in ECommerceCartLines table.

AddOrRemoveMemberTags

Adds or removes tags from a list member. If a tag that does not exist is provided and marked as 'active', a new tag is created.

Stored Procedure Specific Information

Tags can be provided either as a directly specified array or via a TEMP table.

Using TEMP table
Insert into TagsAggregate#TEMP(Name, Status) Values('TestName11', 'inactive');
Insert into TagsAggregate#TEMP(Name, Status) Values('TestName7', 'active');

exec AddOrRemoveMemberTags TagsAggregate = 'TagsAggregate#TEMP', listid = '123', MemberId = 'test';
Directly providing the array
exec AddOrRemoveMemberTags TagsAggregate = '[{"name": "TestName11","status": "inactive"},{"name": "TestName7","status": "active"}]', listid = '123', MemberId = 'test';
Input
Name Type Required Description
ListId String True The unique ID for the list.
MemberId String True The MD5 hash of the lowercase version of the list member's email address.
TagsAggregate String True A list of tags assigned to the list member.
IsSyncing String False When is_syncing is true, automations based on the tags in the request will not fire.
Result Set Columns
Name Type Description
Success String Whether the operation was successful.

AddSubscriberToWorkflowEmail

Manually add a subscriber to a workflow, bypassing the default trigger settings.

Input
Name Type Required Description
WorkflowId String True The Workflow ID of the automation.
EmailId String True The ID of the email used in automation.
EmailAddress String True The email address to add in automation.
Result Set Columns
Name Type Description
Success String Whether the operation was successful.

CampaignCancel

Cancels a Mailchimp Regular or Plain-Text campaign.

Input
Name Type Required Description
CampaignID String True The ID of the campaign to cancel.
Result Set Columns
Name Type Description
Success String Whether the operation was successful.

CampaignPause

Pauses a Mailchimp RSS campaign.

Input
Name Type Required Description
CampaignID String True The ID of the campaign to pause.
Result Set Columns
Name Type Description
Success String Whether the operation was successful.

CampaignResume

Resumes a Mailchimp RSS campaign.

Input
Name Type Required Description
CampaignID String True The ID of the campaign to resume.
Result Set Columns
Name Type Description
Success String Whether the operation was successful.

CampaignSchedule

Schedules a Mailchimp campaign. Either Timewarp or the batch properties can be used, not both.

Input
Name Type Required Description
CampaignID String True The ID of the campaign to schedule.
ScheduleTime String True The local date and time to schedule the campaign for delivery. Campaigns may only be scheduled to send on the quarter-hour (:00, :15, :30, :45).
Timewarp String False Boolean determining whether the campaign should use Timewarp when sending. The default value is false.
BatchCount String False The number of batches to send.
BatchDelay String False The delay, in minutes, between batches
Result Set Columns
Name Type Description
Success String Whether the operation was successful.

CampaignSend

Sends a Mailchimp campaign.

Input
Name Type Required Description
CampaignID String True The ID of the campaign to send.
Result Set Columns
Name Type Description
Success String Whether the operation was successful.

CampaignTest

Sends a test email for a Mailchimp campaign.

Input
Name Type Required Description
CampaignID String True The ID of the campaign to test.
TestEmails String True A comma-separated list of emails to send.
SendType String True The type of test email to send. Either html or plaintext The allowed values are html, plaintext. The default value is html.
Result Set Columns
Name Type Description
Success String Whether the test was successful.

CampaignUnschedule

Unschedules a Mailchimp campaign.

Input
Name Type Required Description
CampaignID String True The ID of the campaign to unschedule.
Result Set Columns
Name Type Description
Success String Whether the operation was successful.

DeleteECommerceCarts

Deletes the ECommerceCart.

Input
Name Type Required Description
StoreId String True The StoreId for the table.
Id String True A unique identifier for the cart.
Result Set Columns
Name Type Description
Success String Whether the operation was successful.

GetOAuthAccessToken

Obtains the OAuth access token to be used for authentication with MailChimp.

Input
Name Type Required Description
AuthMode String True The type of authentication mode to use. The allowed values are APP, WEB. The default value is WEB.
Verifier String False The verifier code returned by Mailchimp after permission for the app to connect has been granted. WEB AuthMode only.
CallbackURL String False This field determines where the response is sent. The value of this parameter must exactly match one of the values registered in the APIs Console, including the HTTP or HTTPS schemes, capitalization, and trailing forward slash ('/').
State String False This field indicates any state that may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to Mailchimp authorization server and back. Uses include redirecting the user to the correct resource in your site, using nonces, and mitigating cross-site request forgery.
Result Set Columns
Name Type Description
OAuthAccessToken String The authentication token returned from MailChimp. This can be used in subsequent calls to other operations for this particular service.
ExpiresIn String The remaining lifetime on the access token.
DataCenter String The datacenter for the user.

GetOAuthAuthorizationURL

Obtains the OAuth authorization URL used for authentication with MailChimp.

Input
Name Type Required Description
CallbackURL String False This field determines where the response is sent. The value of this parameter must exactly match one of the values registered in the APIs Console, including the HTTP or HTTPS schemes, case, and trailing forward slash ('/').
State String False This field indicates any state that may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to the Mailchimp authorization server and back. Possible uses include redirecting the user to the correct resource in your site, using nonces, and mitigating cross-site request forgery.
Result Set Columns
Name Type Description
URL String The URL to complete user authentication.

RemoveSubscriberFromWorkflow

Remove a subscriber from a specific classic automation workflow. You can remove a subscriber at any point in an automation workflow, regardless of how many emails they've sent from that workflow. Once you remove a subscriber, you cannot add them back to the same workflow.

Input
Name Type Required Description
WorkflowId String True The Workflow ID of the automation.
EmailAddress String True The email address of the automation.
Result Set Columns
Name Type Description
Success String Whether the operation was successful.

TransactionalCancelScheduledEmail

Cancels a scheduled email.

Stored Procedure Specific Information

Id input is required in the StoredProcedure

exec TransactionalCancelScheduledEmail ID = '515abc'
Input
Name Type Required Description
Id String True A scheduled email id, as returned by any of the TransactionalSendMessage Stored Procedure or TransactionalScheduledEmails views.
Result Set Columns
Name Type Description
Success String Whether the operation was successful.
Id String the message's unique id.
CreatedAt Datetime the UTC timestamp when the message was created.
SendAt Datetime the UTC timestamp when the message will be sent.
FromEmail String The sending status of the recipient.
To String The email's sender address.
Subject String the email's subject

TransactionalRescheduledEmail

Reschedules a scheduled email.

Stored Procedure Specific Information

Id and SendAt inputs are required in the StoredProcedure

exec TransactionalRescheduledEmail ID = '515abc', SendAt = '2025-08-01T10:10:10.23'
Input
Name Type Required Description
Id String True A scheduled email id, as returned by any of the messages/send calls or messages/list-scheduled.
SendAt Datetime True The new UTC timestamp when the message should sent.
Result Set Columns
Name Type Description
Success String Whether the operation was successful.
Id String the message's unique id.
CreatedAt Datetime the UTC timestamp when the message was created.
SendAt Datetime the UTC timestamp when the message will be sent.
FromEmail String The sending status of the recipient.
To String The email's sender address.
Subject String the email's subject

TransactionalSendMessage

Send a new transactional message through the Transactional API.

Stored Procedure Specific Information

To input is required in the StoredProcedure

exec TransactionalSendMessage To = '[{ \"email\" : \"abc@aaa.com\" , \"name\" : \"ABC\", \"type\" : \"to\"}]';

Alternatively, you can provide ToEmails, CcEmails or BccEmails to create a message

exec TransactionalSendMessage ToEmails='abc@aaa.com,abc@bbb.com,abc@ccc.com', ToNames='XYZ,,ABC', CcEmails='ddd@abc.com,eee@abc.com'
Input
Name Type Required Description
Html String False The full HTML content to be sent.
Text String False Optional full text content to be sent.
Subject String False The message subject.
FromEmail String False The sender email address.
FromName String False Optional from name to be used.
To String False An array of recipient information.
ToEmails String False Comma separated list of emails for type 'to'.
ToNames String False Comma separated list of names for type 'to'.
CcEmails String False Comma separated list of emails for type 'cc'.
CcNames String False Comma separated list of names for type 'cc'.
BccEmails String False Comma separated list of emails for type 'bcc'.
BccNames String False Comma separated list of names for type 'bcc'.
Headers String False Optional extra headers to add to the message.
Important Boolean False Whether or not this message is important, and should be delivered ahead of non-important messages.
TrackOpens Boolean False Whether or not to turn on open tracking for the message.
TrackClicks Boolean False Whether or not to turn on click tracking for the message.
AutoText Boolean False Whether or not to automatically generate a text part for messages that are not given text.
AutoHtml Boolean False Whether or not to automatically generate an HTML part for messages that are not given HTML.
InlineCss Boolean False Whether or not to automatically inline all CSS styles provided in the message HTML - only for HTML documents less than 256KB in size.
UrlStripQs Boolean False Whether or not to strip the query string from URLs when aggregating tracked URL data.
PreserveRecipients Boolean False Whether or not to expose all recipients in to 'To' header for each email.
ViewContentLink Boolean False Set to false to remove content logging for sensitive emails.
BccAddress String False An optional address to receive an exact copy of each recipient's email.
TrackingDomain String False A custom domain to use for tracking opens and clicks instead of mandrillapp.com.
SigningDomain String False A custom domain to use for SPF/DKIM signing instead of mandrill.
ReturnPathDomain String False A custom domain to use for the messages's return-path.
Merge Boolean False Whether to evaluate merge tags in the message.
MergeLanguage String False The merge tag language to use when evaluating merge tags, either mailchimp or handlebars. The allowed values are mailchimp, handlebars.
GlobalMergeVars String False Global merge variables to use for all recipients.
MergeVars String False Per-recipient merge variables, which override global merge variables with the same name.
Tags String False An array of string to tag the message with.
Subaccount String False The unique ID of a subaccount for this message - must already exist or will fail with an error.
GoogleAnalyticsDomains String False An array of strings indicating for which any matching URLs will automatically have Google Analytics parameters appended to their query string automatically.
GoogleAnalyticsCampaign String False Optional string indicating the value to set for the utm_campaign tracking parameter.
Metadata String False Metadata an associative array of user metadata.
RecipientMetadata String False Per-recipient metadata that will override the global values specified in the metadata parameter.
Attachments String False An array of supported attachments to add to the message.
AttachmentLocations String False Comma separated values of file location of attachments.
AttachmentName String False Name of the attachment for which the content is sent in AttachmentContent.
Images String False An array of embedded images to add to the message.
ImageLocations String False Comma separated values of file location of images.
ImageName String False Name of the image for which the content is sent in ImageContent.
Async Boolean False Enable a background sending mode that is optimized for bulk sending.
IpPool String False The name of the dedicated ip pool that should be used to send the message.
SendAt Datetime False When this message should be sent as a UTC timestamp in YYYY-MM-DD HH:MM:SS format.
Result Set Columns
Name Type Description
Success String Whether the operation was successful.
Id String the message's unique id.
Email String The email address of the recipient.
Status String The sending status of the recipient.
RejectReason String the reason for the rejection if the recipient status is 'rejected'.
QueuedReason String A string that uniquely identifies the campaign associated with a cart

TransactionalSendTemplate

Send a new transactional message through the Transactional API using a template.

Stored Procedure Specific Information

TemplateName, TemplateContent and To inputs are required in the StoredProcedure

exec TransactionalSendTemplate TemplateContent = '[{\"name\" : \"aaaa\" , \"content\" : \"nakdkasdmk\"}]', TemplateName = 'abcd', To = '[{ \"email\" : \"abc@aaa.com\" , \"name\" : \"XYZ\", \"type\" : \"to\"}]';

Alternatively, you can provide ToEmails, CcEmails or BccEmails along with TemplateName and TemplateContent to create a template

exec TransactionalSendTemplate TemplateContent = '[{\"name\" : \"aaaa\" , \"content\" : \"nakdkasdmk\"}]', TemplateName = 'abcd', ToEmails='abc@aaa.com,abc@bbb.com,abc@ccc.com', ToNames='XYZ,,ABC', CcEmails='ddd@abc.com,eee@abc.com'
Input
Name Type Required Description
TemplateName String True The immutable slug of a template that exists in the user's account.
TemplateContent String True An array of template content to send.
Html String False The full HTML content to be sent.
Text String False Optional full text content to be sent.
Subject String False The message subject.
FromEmail String False The sender email address.
FromName String False Optional from name to be used.
To String False An array of recipient information.
ToEmails String False Comma separated list of emails for type 'to'.
ToNames String False Comma separated list of names for type 'to'.
CcEmails String False Comma separated list of emails for type 'cc'.
CcNames String False Comma separated list of names for type 'cc'.
BccEmails String False Comma separated list of emails for type 'bcc'.
BccNames String False Comma separated list of names for type 'bcc'.
Headers String False Optional extra headers to add to the message.
Important Boolean False Whether or not this message is important, and should be delivered ahead of non-important messages.
TrackOpens Boolean False Whether or not to turn on open tracking for the message.
TrackClicks Boolean False Whether or not to turn on click tracking for the message.
AutoText Boolean False Whether or not to automatically generate a text part for messages that are not given text.
AutoHtml Boolean False Whether or not to automatically generate an HTML part for messages that are not given HTML.
InlineCss Boolean False Whether or not to automatically inline all CSS styles provided in the message HTML - only for HTML documents less than 256KB in size.
UrlStripQs Boolean False Whether or not to strip the query string from URLs when aggregating tracked URL data.
PreserveRecipients Boolean False Whether or not to expose all recipients in to 'To' header for each email.
ViewContentLink Boolean False Set to false to remove content logging for sensitive emails.
BccAddress String False An optional address to receive an exact copy of each recipient's email.
TrackingDomain String False A custom domain to use for tracking opens and clicks instead of mandrillapp.com.
SigningDomain String False A custom domain to use for SPF/DKIM signing instead of mandrill.
ReturnPathDomain String False A custom domain to use for the messages's return-path.
Merge Boolean False Whether to evaluate merge tags in the message.
MergeLanguage String False The merge tag language to use when evaluating merge tags, either mailchimp or handlebars. The allowed values are mailchimp, handlebars.
GlobalMergeVars String False Global merge variables to use for all recipients.
MergeVars String False Per-recipient merge variables, which override global merge variables with the same name.
Tags String False An array of string to tag the message with.
Subaccount String False The unique ID of a subaccount for this message - must already exist or will fail with an error.
GoogleAnalyticsDomains String False An array of strings indicating for which any matching URLs will automatically have Google Analytics parameters appended to their query string automatically.
GoogleAnalyticsCampaign String False Optional string indicating the value to set for the utm_campaign tracking parameter.
Metadata String False Metadata an associative array of user metadata.
RecipientMetadata String False Per-recipient metadata that will override the global values specified in the metadata parameter.
Attachments String False An array of supported attachments to add to the message.
AttachmentLocations String False Comma separated values of file location of attachments.
AttachmentName String False Name of the attachment for which the content is sent in AttachmentContent.
Images String False An array of embedded images to add to the message.
ImageLocations String False Comma separated values of file location of images.
ImageName String False Name of the image for which the content is sent in ImageContent.
Async Boolean False Enable a background sending mode that is optimized for bulk sending.
IpPool String False The name of the dedicated ip pool that should be used to send the message.
SendAt Datetime False When this message should be sent as a UTC timestamp in YYYY-MM-DD HH:MM:SS format.
Result Set Columns
Name Type Description
Success String Whether the operation was successful.
Id String the message's unique id.
Email String The email address of the recipient.
Status String The sending status of the recipient.
RejectReason String the reason for the rejection if the recipient status is 'rejected'.
QueuedReason String A string that uniquely identifies the campaign associated with a cart

UpdateECommerceCarts

Updates the ECommerceCart. To update lines in ECommerceCarts, please use UPDATE in ECommerceCartLines table.

Input
Name Type Required Description
StoreId String True The StoreId for the table.
Id String True A unique identifier for the cart.
Customer String False Information about a specific customer. Carts for existing customers should include only the ID parameter in the customer object body.
CampaignId String False A string that uniquely identifies the campaign associated with a cart.
CheckoutUrl String False The URL for the cart.
CurrencyCode String False The three-letter ISO 4217 code for the currency that the cart uses.
OrderTotal Decimal False The order total for the cart.
TaxTotal Decimal False The total tax for the cart.
Result Set Columns
Name Type Description
Success String Whether the operation was successful.
Id String ID of the cart.
StoreId String ID of the store.
Customer String Information about a specific customer. Carts for existing customers should include only the ID parameter in the customer object body.
CampaignId String A string that uniquely identifies the campaign associated with a cart
CheckoutUrl String The URL for the cart.
CurrencyCode String The three-letter ISO 4217 code for the currency that the cart uses.
OrderTotal Decimal The order total for the cart.
TaxTotal Decimal The total tax for the cart.

System Tables

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables

The following tables return database metadata for Mailchimp:

Data Source Tables

The following tables return information about how to connect to and query the data source:

  • sys_connection_props: Returns information on the available connection properties.
  • sys_sqlinfo: Describes the SELECT queries that the connector can offload to the data source.

Query Information Tables

The following table returns query statistics for data modification queries:

  • sys_identity: Returns information about batch operations or single updates.

sys_catalogs

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs
Columns
Name Type Description
CatalogName String The database name.

sys_schemas

Lists the available schemas.

The following query retrieves all available schemas:

SELECT * FROM sys_schemas
Columns
Name Type Description
CatalogName String The database name.
SchemaName String The schema name.

sys_tables

Lists the available tables.

The following query retrieves the available tables and views:

SELECT * FROM sys_tables
Columns
Name Type Description
CatalogName String The database containing the table or view.
SchemaName String The schema containing the table or view.
TableName String The name of the table or view.
TableType String The table type (table or view).
Description String A description of the table or view.
IsUpdateable Boolean Whether the table can be updated.

sys_tablecolumns

Describes the columns of the available tables and views.

The following query returns the columns and data types for the Lists table:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Lists'
Columns
Name Type Description
CatalogName String The name of the database containing the table or view.
SchemaName String The schema containing the table or view.
TableName String The name of the table or view containing the column.
ColumnName String The column name.
DataTypeName String The data type name.
DataType Int32 An integer indicating the data type. This value is determined at run time based on the environment.
Length Int32 The storage size of the column.
DisplaySize Int32 The designated column's normal maximum width in characters.
NumericPrecision Int32 The maximum number of digits in numeric data. The column length in characters for character and date-time data.
NumericScale Int32 The column scale or number of digits to the right of the decimal point.
IsNullable Boolean Whether the column can contain null.
Description String A brief description of the column.
Ordinal Int32 The sequence number of the column.
IsAutoIncrement String Whether the column value is assigned in fixed increments.
IsGeneratedColumn String Whether the column is generated.
IsHidden Boolean Whether the column is hidden.
IsArray Boolean Whether the column is an array.
IsReadOnly Boolean Whether the column is read-only.
IsKey Boolean Indicates whether a field returned from sys_tablecolumns is the primary key of the table.
ColumnType String The role or classification of the column in the schema. Possible values include SYSTEM, LINKEDCOLUMN, NAVIGATIONKEY, REFERENCECOLUMN, and NAVIGATIONPARENTCOLUMN.

sys_procedures

Lists the available stored procedures.

The following query retrieves the available stored procedures:

SELECT * FROM sys_procedures
Columns
Name Type Description
CatalogName String The database containing the stored procedure.
SchemaName String The schema containing the stored procedure.
ProcedureName String The name of the stored procedure.
Description String A description of the stored procedure.
ProcedureType String The type of the procedure, such as PROCEDURE or FUNCTION.

sys_procedureparameters

Describes stored procedure parameters.

The following query returns information about all of the input parameters for the GetOAuthAccessToken stored procedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'GetOAuthAccessToken' AND Direction = 1 OR Direction = 2

To include result set columns in addition to the parameters, set the IncludeResultColumns pseudo column to True:

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'GetOAuthAccessToken' AND IncludeResultColumns='True'
Columns
Name Type Description
CatalogName String The name of the database containing the stored procedure.
SchemaName String The name of the schema containing the stored procedure.
ProcedureName String The name of the stored procedure containing the parameter.
ColumnName String The name of the stored procedure parameter.
Direction Int32 An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters.
DataType Int32 An integer indicating the data type. This value is determined at run time based on the environment.
DataTypeName String The name of the data type.
NumericPrecision Int32 The maximum precision for numeric data. The column length in characters for character and date-time data.
Length Int32 The number of characters allowed for character data. The number of digits allowed for numeric data.
NumericScale Int32 The number of digits to the right of the decimal point in numeric data.
IsNullable Boolean Whether the parameter can contain null.
IsRequired Boolean Whether the parameter is required for execution of the procedure.
IsArray Boolean Whether the parameter is an array.
Description String The description of the parameter.
Ordinal Int32 The index of the parameter.
Values String The values you can set in this parameter are limited to those shown in this column. Possible values are comma-separated.
SupportsStreams Boolean Whether the parameter represents a file that you can pass as either a file path or a stream.
IsPath Boolean Whether the parameter is a target path for a schema creation operation.
Default String The value used for this parameter when no value is specified.
SpecificName String A label that, when multiple stored procedures have the same name, uniquely identifies each identically-named stored procedure. If there's only one procedure with a given name, its name is simply reflected here.
IsProvided Boolean Whether the procedure is added/implemented by , as opposed to being a native Mailchimp procedure.
Pseudo-Columns
Name Type Description
IncludeResultColumns Boolean Whether the output should include columns from the result set in addition to parameters. Defaults to False.

sys_keycolumns

Describes the primary and foreign keys.

The following query retrieves the primary key for the Lists table:

SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Lists'
Columns
Name Type Description
CatalogName String The name of the database containing the key.
SchemaName String The name of the schema containing the key.
TableName String The name of the table containing the key.
ColumnName String The name of the key column.
IsKey Boolean Whether the column is a primary key in the table referenced in the TableName field.
IsForeignKey Boolean Whether the column is a foreign key referenced in the TableName field.
PrimaryKeyName String The name of the primary key.
ForeignKeyName String The name of the foreign key.
ReferencedCatalogName String The database containing the primary key.
ReferencedSchemaName String The schema containing the primary key.
ReferencedTableName String The table containing the primary key.
ReferencedColumnName String The column name of the primary key.

sys_foreignkeys

Describes the foreign keys.

The following query retrieves all foreign keys which refer to other tables:

SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
Columns
Name Type Description
CatalogName String The name of the database containing the key.
SchemaName String The name of the schema containing the key.
TableName String The name of the table containing the key.
ColumnName String The name of the key column.
PrimaryKeyName String The name of the primary key.
ForeignKeyName String The name of the foreign key.
ReferencedCatalogName String The database containing the primary key.
ReferencedSchemaName String The schema containing the primary key.
ReferencedTableName String The table containing the primary key.
ReferencedColumnName String The column name of the primary key.
ForeignKeyType String Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key.

sys_primarykeys

Describes the primary keys.

The following query retrieves the primary keys from all tables and views:

SELECT * FROM sys_primarykeys
Columns
Name Type Description
CatalogName String The name of the database containing the key.
SchemaName String The name of the schema containing the key.
TableName String The name of the table containing the key.
ColumnName String The name of the key column.
KeySeq String The sequence number of the primary key.
KeyName String The name of the primary key.

sys_indexes

Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.

The following query retrieves all indexes that are not primary keys:

SELECT * FROM sys_indexes WHERE IsPrimary='false'
Columns
Name Type Description
CatalogName String The name of the database containing the index.
SchemaName String The name of the schema containing the index.
TableName String The name of the table containing the index.
IndexName String The index name.
ColumnName String The name of the column associated with the index.
IsUnique Boolean True if the index is unique. False otherwise.
IsPrimary Boolean True if the index is a primary key. False otherwise.
Type Int16 An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3).
SortOrder String The sort order: A for ascending or D for descending.
OrdinalPosition Int16 The sequence number of the column in the index.

sys_connection_props

Returns information on the available connection properties and those set in the connection string.

The following query retrieves all connection properties that have been set in the connection string or set through a default value:

SELECT * FROM sys_connection_props WHERE Value <> ''
Columns
Name Type Description
Name String The name of the connection property.
ShortDescription String A brief description.
Type String The data type of the connection property.
Default String The default value if one is not explicitly set.
Values String A comma-separated list of possible values. A validation error is thrown if another value is specified.
Value String The value you set or a preconfigured default.
Required Boolean Whether the property is required to connect.
Category String The category of the connection property.
IsSessionProperty String Whether the property is a session property, used to save information about the current connection.
Sensitivity String The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms.
PropertyName String A camel-cased truncated form of the connection property name.
Ordinal Int32 The index of the parameter.
CatOrdinal Int32 The index of the parameter category.
Hierarchy String Shows dependent properties associated that need to be set alongside this one.
Visible Boolean Informs whether the property is visible in the connection UI.
ETC String Various miscellaneous information about the property.

sys_sqlinfo

Describes the SELECT query processing that the connector can offload to the data source.

Discovering the Data Source's SELECT Capabilities

Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.

Name Description Possible Values
AGGREGATE_FUNCTIONS Supported aggregation functions. AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT Whether COUNT function is supported. YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR The opening character used to escape an identifier. [
IDENTIFIER_QUOTE_CLOSE_CHAR The closing character used to escape an identifier. ]
SUPPORTED_OPERATORS A list of supported SQL operators. =, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY Whether GROUP BY is supported, and, if so, the degree of support. NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
STRING_FUNCTIONS Supported string functions. LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONS Supported numeric functions. ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONS Supported date/time functions. NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLES Indicates tables skipped during replication.
REPLICATION_TIMECHECK_COLUMNS A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication.
IDENTIFIER_PATTERN String value indicating what string is valid for an identifier.
SUPPORT_TRANSACTION Indicates if the provider supports transactions such as commit and rollback. YES, NO
DIALECT Indicates the SQL dialect to use.
KEY_PROPERTIES Indicates the properties which identify the uniform database.
SUPPORTS_MULTIPLE_SCHEMAS Indicates if multiple schemas may exist for the provider. YES, NO
SUPPORTS_MULTIPLE_CATALOGS Indicates if multiple catalogs may exist for the provider. YES, NO
DATASYNCVERSION The Data Sync version needed to access this driver. Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY The Data Sync category of this driver. Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL Whether enhanced SQL functionality beyond what is offered by the API is supported. TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS Whether batch operations are supported. YES, NO
SQL_CAP All supported SQL capabilities for this driver. SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS A string value specifies the preferred cacheOptions.
ENABLE_EF_ADVANCED_QUERY Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side. YES, NO
PSEUDO_COLUMNS A string array indicating the available pseudo columns.
MERGE_ALWAYS If the value is true, The Merge Mode is forcibly executed in Data Sync. TRUE, FALSE
REPLICATION_MIN_DATE_QUERY A select query to return the replicate start datetime.
REPLICATION_MIN_FUNCTION Allows a provider to specify the formula name to use for executing a server side min.
REPLICATION_START_DATE Allows a provider to specify a replicate startdate.
REPLICATION_MAX_DATE_QUERY A select query to return the replicate end datetime.
REPLICATION_MAX_FUNCTION Allows a provider to specify the formula name to use for executing a server side max.
IGNORE_INTERVALS_ON_INITIAL_REPLICATE A list of tables which will skip dividing the replicate into chunks on the initial replicate.
CHECKCACHE_USE_PARENTID Indicates whether the CheckCache statement should be done against the parent key column. TRUE, FALSE
CREATE_SCHEMA_PROCEDURES Indicates stored procedures that can be used for generating schema files.

The following query retrieves the operators that can be used in the WHERE clause:

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.

Columns
Name Type Description
NAME String A component of SQL syntax, or a capability that can be processed on the server.
VALUE String Detail on the supported SQL or SQL syntax.

sys_identity

Returns information about attempted modifications.

The following query retrieves the Ids of the modified rows in a batch operation:

SELECT * FROM sys_identity
Columns
Name Type Description
Id String The database-generated ID returned from a data modification operation.
Batch String An identifier for the batch. 1 for a single operation.
Operation String The result of the operation in the batch: INSERTED, UPDATED, or DELETED.
Message String SUCCESS or an error message if the update in the batch failed.

sys_information

Describes the available system information.

The following query retrieves all columns:

SELECT * FROM sys_information
Columns
Name Type Description
Product String The name of the product.
Version String The version number of the product.
Datasource String The name of the datasource the product connects to.
NodeId String The unique identifier of the machine where the product is installed.
HelpURL String The URL to the product's help documentation.
License String The license information for the product. (If this information is not available, the field may be left blank or marked as 'N/A'.)
Location String The file path location where the product's library is stored.
Environment String The version of the environment or rumtine the product is currently running under.
DataSyncVersion String The tier of Sync required to use this connector.
DataSyncCategory String The category of Sync functionality (e.g., Source, Destination).

Advanced Configurations Properties

The advanced configurations properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure. Click the links for further details.

Authentication

Property Description
AuthScheme Whether to use APIKey Authentication or OAuth Authentication when connecting to MailChimp.
APIKey The API key used for accessing your Mailchimp account.

Connection

Property Description
IncludeCustomFields Set whether to include custom fields that are added to the ListMembers view. This defaults to true.

OAuth

Property Description
InitiateOAuth Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working.
OAuthClientId Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecret Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server.
OAuthAccessToken Specifies the OAuth access token used to authenticate requests to the data source. This token is issued by the authorization server after a successful OAuth exchange.
Datacenter The datacenter used for your Mailchimp account.
OAuthSettingsLocation Specifies the location of the settings file where OAuth values are saved. Storing OAuth settings in a central location avoids the need for users to enter OAuth connection properties manually each time they log in. It also enables credentials to be shared across connections or processes.
CallbackURL Identifies the URL users return to after authenticating to Mailchimp via OAuth. (Custom OAuth applications only.).
OAuthVerifier Specifies a verifier code returned from the OAuthAuthorizationURL. Used when authenticating to OAuth on a headless server, where a browser can't be launched. Requires both OAuthSettingsLocation and OAuthVerifier to be set.
OAuthExpiresIn Specifies the duration in seconds, of an OAuth Access Token's lifetime. The token can be reissued to keep access alive as long as the user keeps working.
OAuthTokenTimestamp Displays a Unix epoch timestamp in milliseconds that shows how long ago the current Access Token was created.

SSL

Property Description
SSLServerCert Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Schema

Property Description
Location Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
BrowsableSchemas Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA, SchemaB, SchemaC.
Tables Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA, TableB, TableC.
Views Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA, ViewB, ViewC.

Miscellaneous

Property Description
MaxRows Specifies the maximum rows returned for queries without aggregation or GROUP BY.
Other Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
Pagesize The maximum number of records per page the provider returns when requesting data from Mailchimp.
PseudoColumns Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
Timeout Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
UserDefinedViews Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

Authentication

This section provides a complete list of authentication properties you can configure.

Property Description
AuthScheme Whether to use APIKey Authentication or OAuth Authentication when connecting to MailChimp.
APIKey The API key used for accessing your Mailchimp account.

AuthScheme

Whether to use APIKey Authentication or OAuth Authentication when connecting to MailChimp.

Possible Values

OAuth, APIKey

Data Type

string

Default Value

APIKey

Remarks
  • OAuth: Set this to perform OAuth authentication.
  • APIKey: Set this to perform APIKey authentication.

APIKey

The API key used for accessing your Mailchimp account.

Data Type

string

Default Value

""

Remarks

The API key used for accessing your Mailchimp account. The API key can be found in Mailchimp by going to Account -> Extras -> API Keys.

Connection

This section provides a complete list of connection properties you can configure.

Property Description
IncludeCustomFields Set whether to include custom fields that are added to the ListMembers view. This defaults to true.

IncludeCustomFields

Set whether to include custom fields that are added to the ListMembers view. This defaults to true.

Data Type

bool

Default Value

true

Remarks

Set whether to include custom fields that are added to the ListMembers view. This defaults to true.

OAuth

This section provides a complete list of OAuth properties you can configure.

Property Description
InitiateOAuth Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working.
OAuthClientId Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecret Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server.
OAuthAccessToken Specifies the OAuth access token used to authenticate requests to the data source. This token is issued by the authorization server after a successful OAuth exchange.
Datacenter The datacenter used for your Mailchimp account.
OAuthSettingsLocation Specifies the location of the settings file where OAuth values are saved. Storing OAuth settings in a central location avoids the need for users to enter OAuth connection properties manually each time they log in. It also enables credentials to be shared across connections or processes.
CallbackURL Identifies the URL users return to after authenticating to Mailchimp via OAuth. (Custom OAuth applications only.).
OAuthVerifier Specifies a verifier code returned from the OAuthAuthorizationURL. Used when authenticating to OAuth on a headless server, where a browser can't be launched. Requires both OAuthSettingsLocation and OAuthVerifier to be set.
OAuthExpiresIn Specifies the duration in seconds, of an OAuth Access Token's lifetime. The token can be reissued to keep access alive as long as the user keeps working.
OAuthTokenTimestamp Displays a Unix epoch timestamp in milliseconds that shows how long ago the current Access Token was created.

InitiateOAuth

Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working.

Possible Values

OFF, REFRESH, GETANDREFRESH

Data Type

string

Default Value

OFF

Remarks

OAuth is an authorization framework that enables applications to obtain limited access to user accounts on an HTTP service. The OAuth flow defines the method to be used for logging in users, exchanging their credentials for an OAuth access token to be used for authentication, and providing limited access to applications.

Mailchimp supports the following options for initiating OAuth access:

  1. OFF: No automatic OAuth flow initiation. The OAuth flow is handled entirely by the user, who will take action to obtain their OAuthAccessToken. Note that with this setting the user must refresh the token manually and reconnect with an updated OAuthAccessToken property when the current token expires.
  2. GETANDREFRESH: The OAuth flow is handled entirely by the connector. If a token already exists, it is refreshed when necessary. If no token currently exists, it will be obtained by prompting the user to login.
  3. REFRESH: The user handles obtaining the OAuth Access Token and sets up the sequence for refreshing the OAuth Access Token. (The user is never prompted to log in to authenticate. After the user logs in, the connector handles the refresh of the OAuth Access Token.

OAuthClientId

Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.

Data Type

string

Default Value

""

Remarks

This property is required when using a custom OAuth application, such as in web-based authentication flows, service-based authentication, or certificate-based flows that require application registration. It is also required if an embedded OAuth application is not available for the driver. When an embedded OAuth application is available, this value may already be provided by the connector and not require manual entry.

This value is generally used alongside other OAuth-related properties such as OAuthClientSecret and OAuthSettingsLocation when configuring an authenticated connection.

OAuthClientId is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can typically find this value in your identity provider’s application registration settings. Look for a field labeled Client ID, Application ID, or Consumer Key.

While the client ID is not considered a confidential value like a client secret, it is still part of your application's identity and should be handled carefully. Avoid exposing it in public repositories or shared configuration files.

OAuthClientSecret

Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server.

Data Type

string

Default Value

""

Remarks

This property is required when using a custom OAuth application in any flow that requires secure client authentication, such as web-based OAuth, service-based connections, or certificate-based authorization flows. It is not required when using an embedded OAuth application.

The client secret is used during the token exchange step of the OAuth flow, when the driver requests an access token from the authorization server. If this value is missing or incorrect, authentication will fail, and the server may return an invalid_client or unauthorized_client error.

OAuthClientSecret is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can obtain this value from your identity provider when registering the OAuth application. It may be referred to as the client secret, application secret, or consumer secret.

This value should be stored securely and never exposed in public repositories, scripts, or unsecured environments. Client secrets may also expire after a set period. Be sure to monitor expiration dates and rotate secrets as needed to maintain uninterrupted access.

OAuthAccessToken

Specifies the OAuth access token used to authenticate requests to the data source. This token is issued by the authorization server after a successful OAuth exchange.

Data Type

string

Default Value

""

Remarks

The OAuthAccessToken is a temporary credential that authorizes access to protected resources. It is typically returned by the identity provider after the user or client application completes an OAuth authentication flow. This property is most commonly used in automated workflows or custom OAuth implementations where you want to manage token handling outside of the driver.

The OAuth access token has a server-dependent timeout, limiting user access. This is set using the OAuthExpiresIn property. However, it can be reissued between requests to keep access alive as long as the user keeps working.

If InitiateOAuth is set to REFRESH, we recommend that you also set both OAuthExpiresIn and OAuthTokenTimestamp. The connector uses these properties to determine when the token expires so it can refresh most efficiently. If OAuthExpiresIn and OAuthTokenTimestamp are not specified, the connector refreshes the token immediately.

Access tokens should be treated as sensitive credentials and stored securely. Avoid exposing them in logs, scripts, or configuration files that are not access-controlled.

Datacenter

The datacenter used for your Mailchimp account.

Possible Values

None, US1, US2, US3, US4, US5, US6, US7, US8, US9, US10, US11, US12, US13

Data Type

string

Default Value

None

Remarks

The datacenter used for your Mailchimp account. This value can be found in the URL when logging into Mailchimp in the browser. The datacenter is embedded in the APIKey and when using OAuth the connector obtains the datacenter automatically. However, you can set this property to save an extra request when you authenticate using OAuth.

OAuthSettingsLocation

Specifies the location of the settings file where OAuth values are saved. Storing OAuth settings in a central location avoids the need for users to enter OAuth connection properties manually each time they log in. It also enables credentials to be shared across connections or processes.

Data Type

string

Default Value

%APPDATA%\MailChimp Data Provider\OAuthSettings.txt

Remarks

You can store OAuth values in a central file for shared access to those values, in either of the following ways:

  • Set InitiateOAuth to either GETANDREFRESH or REFRESH and specify a filepath to the OAuth settings file.
  • Use memory storage to load the credentials into static memory.

The following sections provide more detail on each of these methods.

Specifying the OAuthSettingsLocation Filepath

The default OAuth setting location is %APPDATA%\MailChimp Data Provider\OAuthSettings.txt, with %APPDATA% set to the user's configuration directory.

Default values vary, depending on the user's operating system.

  • Windows (ODBC and Power BI): registry://%DSN%
  • Windows: %APPDATA%MailChimp Data Provider\OAuthSettings.txt
  • Mac: %APPDATA%//MailChimp Data Provider/OAuthSettings.txt
  • Linux: %APPDATA%//MailChimp Data Provider/OAuthSettings.txt
Loading Credentials Via Memory Storage

Memory locations are specified by using a value starting with memory://, followed by a unique identifier for that set of credentials (for example, memory://user1). The identifier can be anything you choose, but it should be unique to the user.

Unlike file-based storage, where credentials persist across connections, memory storage loads the credentials into static memory and the credentials are shared between connections using the same identifier for the life of the process. To persist credentials outside the current process, you must manually store the credentials prior to closing the connection. This enables you to set them in the connection when the process is started again.

To retrieve OAuth property values, query the sys_connection_props system table. If there are multiple connections using the same credentials, the properties are read from the previously closed connection.

Supported Storage Types

  • memory://: Stores OAuth tokens in-memory (unique identifier, shared within same process, etc.)
  • registry://: Only supported in the Windows ODBC and Power BI editions. Stores OAuth tokens in the registry under the DSN settings. Must end in a DSN name like registry://Mailchimp connector Data Source, or registry://%DSN%.
  • %DSN%: The name of the DSN you are connecting with.
  • Default (no prefix): Stores OAuth tokens within files. The value can be either an absolute path, or a path starting with %APPDATA% or %PROGRAMFILES%.

CallbackURL

Identifies the URL users return to after authenticating to Mailchimp via OAuth. (Custom OAuth applications only.).

Data Type

string

Default Value

""

Remarks

If you created a custom OAuth application, the OAuth authorization server redirects the user to this URL during the authentication process. This value must match the callback URL you specified when you Configured the custom OAuth application.

OAuthVerifier

Specifies a verifier code returned from the OAuthAuthorizationURL. Used when authenticating to OAuth on a headless server, where a browser can't be launched. Requires both OAuthSettingsLocation and OAuthVerifier to be set.

Data Type

string

Default Value

""

OAuthExpiresIn

Specifies the duration in seconds, of an OAuth Access Token's lifetime. The token can be reissued to keep access alive as long as the user keeps working.

Data Type

string

Default Value

""

Remarks

The OAuth Access Token is assigned to an authenticated user, granting that user access to the network for a specified period of time. The access token is used in place of the user's login ID and password, which stay on the server.

An access token created by the server is only valid for a limited time. OAuthExpiresIn is the number of seconds the token is valid from when it was created. For example, a token generated at 2024-01-29 20:00:00 UTC that expires at 2024-01-29 21:00:00 UTC (an hour later) would have an OAuthExpiresIn value of 3600, no matter what the current time is.

To determine how long the user has before the Access Token will expire, use OAuthTokenTimestamp.

OAuthTokenTimestamp

Displays a Unix epoch timestamp in milliseconds that shows how long ago the current Access Token was created.

Data Type

string

Default Value

""

Remarks

The OAuth Access Token is assigned to an authenticated user, granting that user access to the network for a specified period of time. The access token is used in place of the user's login ID and password, which stay on the server.

An access token created by the server is only valid for a limited time. OAuthTokenTimestamp is the Unix timestamp when the server created the token. For example, OAuthTokenTimestamp=1706558400 indicates the OAuthAccessToken was generated by the server at 2024-01-29 20:00:00 UTC.

SSL

This section provides a complete list of SSL properties you can configure.

Property Description
SSLServerCert Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

SSLServerCert

Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Data Type

string

Default Value

""

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.

This property can take the following forms:

Description Example
A full PEM Certificate (example shortened for brevity) -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
A path to a local file containing the certificate C:\\cert.cer
The public key (example shortened for brevity) -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
The MD5 Thumbprint (hex values can also be either space or colon separated) ecadbdda5a1529c58a1e9e09828d70e4
The SHA1 Thumbprint (hex values can also be either space or colon separated) 34a929226ae0819f2ec14b4a3d904f801cbb150d

If not specified, any certificate trusted by the machine is accepted.

Certificates are validated as trusted by the machine based on the System's trust store. The trust store used is the 'javax.net.ssl.trustStore' value specified for the system. If no value is specified for this property, Java's default trust store is used (for example, JAVA_HOME\lib\security\cacerts).

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

Schema

This section provides a complete list of schema properties you can configure.

Property Description
Location Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
BrowsableSchemas Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA, SchemaB, SchemaC.
Tables Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA, TableB, TableC.
Views Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA, ViewB, ViewC.

Location

Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.

Data Type

string

Default Value

%APPDATA%\MailChimp Data Provider\Schema

Remarks

The Location property is only needed if you want to either customize definitions (for example, change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is %APPDATA%\MailChimp Data Provider\Schema, where %APPDATA% is set to the user's configuration directory:

Platform %APPDATA%
Windows The value of the APPDATA environment variable
Mac ~/Library/Application Support
Linux ~/.config

BrowsableSchemas

Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Data Type

string

Default Value

""

Remarks

Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.

Tables

Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC.

Data Type

string

Default Value

""

Remarks

Listing all available tables from some databases can take extra time, thus degrading performance. Providing a list of tables in the connection string saves time and improves performance.

If there are lots of tables available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those tables. To do this, specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note

If you are connecting to a data source with multiple schemas or catalogs, you must specify each table you want to view by its fully qualified name. This avoids ambiguity between tables that may exist in multiple catalogs or schemas.

Views

Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Data Type

string

Default Value

""

Remarks

Listing all available views from some databases can take extra time, thus degrading performance. Providing a list of views in the connection string saves time and improves performance.

If there are lots of views available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those views. To do this, specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Note

If you are connecting to a data source with multiple schemas or catalogs, you must specify each view you want to examine by its fully qualified name. This avoids ambiguity between views that may exist in multiple catalogs or schemas.

Miscellaneous

This section provides a complete list of miscellaneous properties you can configure.

Property Description
MaxRows Specifies the maximum rows returned for queries without aggregation or GROUP BY.
Other Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
Pagesize The maximum number of records per page the provider returns when requesting data from Mailchimp.
PseudoColumns Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
Timeout Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
UserDefinedViews Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

MaxRows

Specifies the maximum rows returned for queries without aggregation or GROUP BY.

Data Type

int

Default Value

-1

Remarks

This property sets an upper limit on the number of rows the connector returns for queries that do not include aggregation or GROUP BY clauses. This limit ensures that queries do not return excessively large result sets by default.

When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting. If MaxRows is set to "-1", no row limit is enforced unless a LIMIT clause is explicitly included in the query.

This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.

Other

Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.

Data Type

string

Default Value

""

Remarks

This property allows advanced users to configure hidden properties for specialized scenarios. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. Multiple properties can be defined in a semicolon-separated list.

Note

It is strongly recommended to set these properties only when advised by the support team to address specific scenarios or issues.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting
Property Description
DefaultColumnSize Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMT=True Converts date-time values to GMT, instead of the local time of the machine. The default value is False (use local time).
RecordToFile=filename Records the underlying socket data transfer to the specified file.

Pagesize

The maximum number of records per page the provider returns when requesting data from Mailchimp.

Data Type

int

Default Value

1000

Remarks

When processing a query, instead of requesting all of the queried data at once from Mailchimp, the connector can request the queried data in pieces called pages.

This connection property determines the maximum number of results that the connector requests per page.

Note that setting large page sizes may improve overall query execution time, but doing so causes the connector to use more memory when executing queries and risks triggering a timeout.

PseudoColumns

Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.

Data Type

string

Default Value

""

Remarks

This property allows you to define which pseudocolumns the connector exposes as table columns.

To specify individual pseudocolumns, use the following format: "Table1=Column1;Table1=Column2;Table2=Column3"

To include all pseudocolumns for all tables use: "*=*"

Timeout

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.

Data Type

int

Default Value

60

Remarks

This property controls the maximum time, in seconds, that the connector waits for an operation to complete before canceling it. If the timeout period expires before the operation finishes, the connector cancels the operation and throws an exception.

The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond the timeout value if each paging call completes within the timeout limit.

Setting this property to 0 disables the timeout, allowing operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server. Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.

UserDefinedViews

Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

Data Type

string

Default Value

""

Remarks

This property allows you to define and manage custom views through a JSON-formatted configuration file called UserDefinedViews.json. These views are automatically recognized by the connector and enable you to execute custom SQL queries as if they were standard database views. The JSON file defines each view as a root element with a child element called "query", which contains the SQL query for the view. For example:

{
    "MyView": {
        "query": "SELECT * FROM Lists WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }

}

You can define multiple views in a single file and specify the filepath using this property. For example: UserDefinedViews=C:\Path\To\UserDefinedViews.json. When you use this property, only the specified views are seen by the connector.

Refer to User Defined Views for more information.