Excel Add-In for Mailchimp

Build 26.0.9655

Campaigns

Provides detailed information on campaigns created within the account, including type, status, and send statistics.

Table-Specific Information

SELECT, UPDATE, and DELETE are supported for Campaigns.

Select

The add-in uses the Mailchimp API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the add-in.

ColumnSupported Operators
Id=
Type=
CreateTime=, <, >, <=, >=
SendTime=, <, >, <=, >=
Status=
Recipients_ListId=
Settings_FolderId=

For example, the following queries are processed server-side: 

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'

Additionally, the CreateTime column can be used in the ORDER BY clause, as follows: 

SELECT * FROM Campaigns ORDER BY CreateTime DESC

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 operations 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 are not updateable in this case.

Columns

Name Type ReadOnly References Description
Id [KEY] String True

The unique identifier assigned to the campaign within the Mailchimp account.

Type String False

Specifies the type of campaign, such as regular, plaintext, absplit, or rss.

CreateTime Datetime True

The date and time when the campaign was created.

ArchiveUrl String True

The URL of the campaign's archived version, accessible via the campaign archive.

LongArchiveUrl String True

The original full-length URL of the campaign archive version.

Status String True

Indicates the current state of the campaign, such as save, paused, schedule, sending, or sent.

EmailsSent Integer True

The total number of emails successfully sent for this campaign.

SendTime Datetime True

The date and time when the campaign was sent to recipients.

ContentType String False

Defines how the campaign content is structured, such as template, drag_and_drop, HTML, or URL.

Recipients_ListId String False

Lists.Id

The unique identifier of the audience list targeted by the campaign.

Recipients_ListName String True

The display name of the audience list associated with the campaign.

Recipients_SegmentText String True

A formatted HTML string describing the audience segment used for this campaign in plain language.

Recipients_RecipientCount Integer True

The total number of recipients included in the campaign's target audience.

Recipients_SegmentOpts String False

The segmentation parameters that define which subscribers received this campaign.

Settings_SubjectLine String False

The subject line displayed in recipients' inboxes for the campaign email.

Settings_Title String False

The internal title of the campaign as shown within the Mailchimp interface.

Settings_FromName String False

The sender name displayed in recipients' inboxes for the campaign.

Settings_ReplyTo String False

The reply-to email address used for recipient responses to the campaign.

Settings_UseConversation Boolean False

If the value is 'true', Mailchimp's Conversations feature is enabled to manage replies within the platform.

Settings_ToName String False

The personalized 'To' field value used in the campaign, typically populated with a merge tag like the recipient's first name.

Settings_FolderId String False

The identifier of the folder in which this campaign is stored, if applicable.

Settings_Authenticate Boolean False

If the value is 'true', Mailchimp authenticated the campaign to improve deliverability. The default value is 'true'.

Settings_AutoFooter Boolean False

If the value is 'true', Mailchimp automatically appends the default footer to the campaign content.

Settings_InlineCss Boolean False

If the value is 'true', CSS styles are automatically inlined within the campaign's HTML for improved compatibility.

Settings_AutoTweet Boolean False

If the value is 'true', Mailchimp automatically posts a tweet linking to the campaign archive when the campaign is sent.

Settings_AutoFbPost String False

A list of Facebook page IDs where the campaign is automatically shared when sent.

Settings_FbComments Boolean False

If the value is 'true', Facebook comments are enabled on the campaign archive, allowing recipients to leave feedback.

Settings_Timewarp Boolean True

If the value is 'true', the campaign uses Mailchimp's Timewarp feature to send emails based on recipients' local time zones.

Settings_TemplateId Integer False

Templates.Id

The identifier of the email template used to design the campaign.

Settings_DragAndDrop Boolean True

If the value is 'true', the campaign was created using Mailchimp's drag-and-drop editor.

VariateSettings_WinningCombinationId String True

The identifier of the A/B test combination selected as the winning version.

VariateSettings_WinningCampaignId String True

The identifier of the campaign version sent to the remaining recipients after a winner was chosen.

VariateSettings_WinnerCriteria String False

Specifies the metric used to determine the winning campaign version, such as opens, clicks, or manual selection.

VariateSettings_WaitTime Integer False

The number of minutes Mailchimp waits before selecting the winning campaign variation.

VariateSettings_TestSize Integer False

The percentage of the audience used for testing in an A/B split, ranging from 10 to 100.

VariateSettings_SubjectLines String False

Lists the subject lines used in different campaign variations for testing.

VariateSettings_SendTimes String False

Lists the send times tested across A/B campaign variations.

VariateSettings_FromNames String False

Lists the different 'From' names used across the A/B campaign variations.

VariateSettings_ReplyToAddresses String False

Lists the reply-to addresses tested across campaign variations.

VariateSettings_Contents String True

Describes the content variations used in the A/B test campaigns.

VariateSettings_Combinations String True

Lists the specific combinations of variables used to create each campaign variant.

Tracking_Opens Boolean False

If the value is 'true', open tracking is enabled for the campaign. The default value is 'true'.

Tracking_HtmlClicks Boolean False

If the value is 'true', click tracking is enabled for links in the HTML version of the campaign. The default value is 'true'.

Tracking_TextClicks Boolean False

If the value is 'true', click tracking is enabled for links in the plain-text version of the campaign. The default value is 'true'.

Tracking_GoalTracking Boolean False

If the value is 'true', Goal tracking is enabled to measure conversions and subscriber activity on linked websites.

Tracking_Ecomm360 Boolean False

If the value is 'true', eCommerce360 tracking is enabled to associate campaign performance with sales data.

Tracking_GoogleAnalytics String False

The custom slug used for Google Analytics tracking, limited to 50 bytes.

Tracking_Clicktale String False

The custom slug used for ClickTale Analytics tracking, limited to 50 bytes.

Tracking_Salesforce String False

Salesforce tracking options for the campaign, available when using Mailchimp's Salesforce integration.

Tracking_Capsule String False

Capsule CRM tracking options for the campaign, available when using Mailchimp's Capsule integration.

RssOpts_FeedUrl String False

The RSS feed URL used for generating campaign content in an RSS-to-Email campaign.

RssOpts_Frequency String False

The frequency of the RSS campaign, such as daily, weekly, or monthly.

RssOpts_Schedule String False

The defined schedule for sending the RSS-to-Email campaign.

RssOpts_LastSent String True

The date when the RSS campaign was last sent.

RssOpts_ConstrainRssImg Boolean False

If the value is 'true', Mailchimp constrains image widths from RSS feeds within the campaign layout.

AbSplitOpts_SplitTest String True

Specifies the type of A/B split used in the campaign, such as subject, from_name, or schedule.

AbSplitOpts_PickWinner String True

Defines how the winning version of the A/B test is selected, based on opens, clicks, or manual choice.

AbSplitOpts_WaitUnits String True

Specifies the unit of time (hours or days) used to determine when a winner is chosen.

AbSplitOpts_WaitTime Integer True

The duration to wait before selecting a winning version after sending test variants.

AbSplitOpts_SplitSize Integer True

The percentage of subscribers included in the test groups for A/B campaigns, typically between 1 and 50.

AbSplitOpts_FromNameA String True

The 'From' name used for Group A in an A/B test campaign.

AbSplitOpts_FromNameB String True

The 'From' name used for Group B in an A/B test campaign.

AbSplitOpts_ReplyEmailA String True

The reply-to email address used for Group A in an A/B test.

AbSplitOpts_ReplyEmailB String True

The reply-to email address used for Group B in an A/B test.

AbSplitOpts_SubjectA String True

The subject line assigned to Group A in an A/B test campaign.

AbSplitOpts_SubjectB String True

The subject line assigned to Group B in an A/B test campaign.

AbSplitOpts_SendTimeA Datetime True

The date and time when the A/B test campaign for Group A was sent.

AbSplitOpts_SendTimeB Datetime True

The date and time when the A/B test campaign for Group B was sent.

AbSplitOpts_SendTimeWinner Datetime True

The date and time when the winning version of the campaign was sent to the remaining audience.

SocialCard_ImageUrl String False

The URL of the image displayed in social media previews for the campaign.

SocialCard_Description String False

A short description of the campaign content shown in social media previews.

SocialCard_Title String False

The title displayed in the social preview card, typically matching the campaign's subject line.

ReportSummary String True

Summarizes engagement metrics for sent campaigns, including opens, clicks, and unsubscribes.

DeliveryStatus String True

Indicates the current delivery progress or any ongoing sending activity for the campaign.

WebId Integer True

The internal Mailchimp web application identifier used to access the campaign at https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}.

ParentCampaignId String True

If this campaign is part of another, identifies the parent campaign, such as for RSS or automation child campaigns.

NeedsBlockRefresh Boolean True

If the value is 'true', indicates that the campaign content needs refreshing in the Mailchimp editor. Deprecated; always returns false.

Resendable Boolean True

If the value is 'true', the campaign can be resent to subscribers who did not open the original message.

Recipients_ListIsActive Boolean True

If the value is 'true', the audience list used for this campaign is active. If the value is 'false', it has been deleted or disabled.

Settings_PreviewText String False

The preview text shown alongside the subject line in recipients' inboxes.

ItemURL String True

The full URL reference of the campaign item within the Mailchimp interface.

Copyright (c) 2026 CData Software, Inc. - All rights reserved.
Build 26.0.9655