Skip to content

Campaign

Campaign connects your flow to your Mailchimp account to work with email campaigns: look up one campaign or the list of campaigns, send it, duplicate it, resend it, delete it and get its results report.

It is useful when you want sending or tracking your campaigns to be part of an automatic process, for example sending a campaign that is already prepared when it is approved in another tool, or receiving a weekly summary of results.

When to use it

  • Your team prepares a campaign in Mailchimp and you want to send it when someone approves it from a form or a message.
  • Every Monday you want a report with the opens and clicks of the latest campaigns.
  • You want to duplicate last month’s campaign as the starting point for the new one.
  • An AI agent answers internal questions about which campaigns have been sent and how they performed.

Configuration

You need a Mailchimp API credential with the API key of your account. You find it in Mailchimp, on the API Keys page of your account. See Credentials.

FieldWhat it does
Credential (required)The Mailchimp API credential used to access your account.
OperationWhat the component does. See Operations. Default: Get Campaigns.
Campaign IDThe campaign’s ID. In Get Campaigns it is optional: if you fill it in, that campaign is fetched directly. Required in Send Campaign, Replicate Campaign, Delete Campaign and Resend Campaign. In Get Reports, it is the campaign you want the report for; with Regular Campaign Report or Ecommerce Campaign Report you can leave it empty to get the reports of all sent campaigns. Required for Clicks Campaign Report and Opens Campaign Report.
Max ResultsIn Get Campaigns and Get Reports. The maximum number of results to fetch. Default: 10.
Report TypeOnly in Get Reports. The type of report. Regular Campaign Report fetches the campaign’s overall figures (sends, opens, clicks, bounces and forwards) and Ecommerce Campaign Report the sales attributed to the campaign (orders, revenue and currency). Default: Regular Campaign Report.

Operations

OperationWhat it does
Get CampaignsFetches one campaign or the list of campaigns, with their title, sender and status.
Send CampaignSends a campaign that is already prepared in Mailchimp.
Replicate CampaignCreates a copy of a campaign and returns the new copy.
Delete CampaignDeletes a campaign.
Resend CampaignCreates a resend of a campaign that was already sent and sends it.
Get ReportsFetches the results report of a campaign, or of all sent campaigns. Clicks Campaign Report returns one item per clicked link and Opens Campaign Report one item per subscriber who opened it.

Advanced options

Only in Get Campaigns, to filter the list of campaigns when you do not set Campaign ID.

FieldWhat it does
Aply FiltersTurn it on to filter the list. Off by default.
Filter ByWith Aply Filters on. The filters you want to use; you can pick several: Status, Type, Before Send Time, After Send Time, Before Create Time and After Create Time. Each one shows its own field.
StatusWith the Status filter. Only campaigns in that status: save (draft), paused, sent, schedule or sending. Default: save.
TypeWith the Type filter. Only campaigns of that type: regular, plaintext, absplit, rss or sent. Default: regular.
Before Send Time and After Send TimeWith those filters. Only campaigns sent before or after the date and time you choose.
Before Create Time and After Create TimeWith those filters. Only campaigns created before or after the date and time you choose.

Output

The Data output returns one item per campaign or report found. In Send Campaign, Delete Campaign and Resend Campaign it returns a confirmation with the campaign ID. In Replicate Campaign it returns the new copy, with its new ID.

You can connect the result to an agent that summarizes the reports, to a spreadsheet or to a message for your team. The component can also be connected to an Agent as a tool, so the agent decides when to look up or send campaigns. See Tool Mode.

Example

An online store wants a weekly summary of its latest campaign.

  1. Schedule the flow to run on Mondays from the Scheduler.
  2. Add Campaign with Get Campaigns, turn on Aply Filters, pick Status in Filter By and set Status to sent.
  3. Add another Campaign with Get Reports, Report Type set to Regular Campaign Report and the Campaign ID of the campaign found.
  4. Connect the Data output to an agent that writes the summary and to an email component that sends it to the team.

Good practices

  • Send Campaign really sends the campaign to its whole audience. Test it in Mailchimp first and, if an agent uses the flow, state clearly in its instructions when it may send it.
  • The Campaign ID appears in the Get Campaigns list. Keep it if you are going to send, duplicate or delete that campaign later.