← Mailchimp

Create Campaign with Mailchimp API

Pipedream makes it easy to connect APIs for Mailchimp and 2,400+ other apps remarkably fast.

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Create Campaign with the Mailchimp API
No credit card required
Intro to Pipedream
Watch us build a workflow
Watch us build a workflow
8 min
Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo
Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo

Developers Pipedream

Getting Started

Create a workflow to Create Campaign with the Mailchimp API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the Create Campaign action
    1. Connect your Mailchimp account
    2. Select a Type
    3. Select a List Id
    4. Optional- Configure Saved segment ID
    5. Optional- Configure Prebuilt segment ID
    6. Optional- Select a Segment match
    7. Optional- Configure Segment conditions
    8. Optional- Configure Subject line
    9. Optional- Configure Preview text
    10. Optional- Configure Title
    11. Optional- Configure From name
    12. Optional- Configure Reply to
    13. Optional- Configure Use conversation
    14. Optional- Configure To name
    15. Optional- Configure Folder ID
    16. Optional- Configure Authenticate
    17. Optional- Configure Auto footer
    18. Optional- Configure Inline css
    19. Optional- Configure Auto tweet
    20. Optional- Configure Auto fb post
    21. Optional- Configure FB comments
    22. Optional- Configure Template ID
    23. Optional- Configure Opens
    24. Optional- Configure HTML clicks
    25. Optional- Configure Text clicks
    26. Optional- Configure Goal tracking
    27. Optional- Configure E-commerce tracking
    28. Optional- Configure Google analytics
    29. Optional- Configure Clicktale
    30. Optional- Configure Salesforce campaign
    31. Optional- Configure Salesforce notes
    32. Optional- Configure Capsule notes
    33. Optional- Configure Social image url
    34. Optional- Configure Social description
    35. Optional- Select a Social title
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Integrations

Create Campaign with Mailchimp API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + Mailchimp
 
Try it
Create Campaign with Mailchimp API on New Item in Feed from RSS API
RSS + Mailchimp
 
Try it
Create Campaign with Mailchimp API on New Message from Discord API
Discord + Mailchimp
 
Try it
Create Campaign with Mailchimp API on New Message In Channels from Slack API
Slack + Mailchimp
 
Try it
Create Campaign with Mailchimp API on New Message in Channel from Discord Bot API
Discord Bot + Mailchimp
 
Try it

Details

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Create Campaign on Mailchimp
Description:Creates a new campaign draft. [See docs here](https://mailchimp.com/developer/marketing/api/campaigns/add-campaign/)
Version:0.2.2
Key:mailchimp-create-campaign

Code

import mailchimp from "../../mailchimp.app.mjs";
import { removeNullEntries } from "../../common/utils.mjs";
import constants from "../../common/constants.mjs";

export default {
  key: "mailchimp-create-campaign",
  name: "Create Campaign",
  description: "Creates a new campaign draft. [See docs here](https://mailchimp.com/developer/marketing/api/campaigns/add-campaign/)",
  version: "0.2.2",
  type: "action",
  props: {
    mailchimp,
    type: {
      label: "Type",
      type: "string",
      description: "There are four types of campaigns you can create in Mailchimp. A/B Split campaigns have been deprecated and variate campaigns should be used instead.",
      options: constants.CAMPAIGN_TYPE,
    },
    listId: {
      propDefinition: [
        mailchimp,
        "listId",
      ],
      label: "List Id",
      description: "The unique ID of the list",
    },
    savedSegmentId: {
      label: "Saved segment ID",
      type: "integer",
      description: "The ID for an existing saved segment.",
      optional: true,
    },
    prebuiltSegmentId: {
      label: "Prebuilt segment ID",
      type: "string",
      description: "The prebuilt segment ID, if a prebuilt segment has been designated for this campaign.",
      optional: true,
    },
    segmentMatch: {
      label: "Segment match",
      type: "string",
      description: "Segment match type.",
      optional: true,
      options: [
        "any",
        "all",
      ],
    },
    segmentConditions: {
      label: "Segment conditions",
      type: "any",
      description: "Segment match conditions.",
      optional: true,
    },
    subjectLine: {
      label: "Subject line",
      type: "string",
      description: "The subject line for the campaign.",
      optional: true,
    },
    previewText: {
      label: "Preview text",
      type: "string",
      description: "The preview text for the campaign.",
      optional: true,
    },
    title: {
      label: "Title",
      type: "string",
      description: "The title of the campaign.",
      optional: true,
    },
    fromName: {
      label: "From name",
      type: "string",
      description: "The 'from' name on the campaign (not an email address).",
      optional: true,
    },
    replyTo: {
      label: "Reply to",
      type: "string",
      description: "The reply-to email address for the campaign. Note: while this field is not required for campaign creation, it is required for sending.",
      optional: true,
    },
    useConversation: {
      label: "Use conversation",
      type: "boolean",
      description: "Use Mailchimp Conversation feature to manage out-of-office replies.",
      optional: true,
    },
    toName: {
      label: "To name",
      type: "string",
      description: "The campaign's custom to name.",
      optional: true,
    },
    folderId: {
      label: "Folder ID",
      type: "string",
      description: "If the campaign is listed in a folder, the ID for that folder.",
      optional: true,
    },
    authenticate: {
      label: "Authenticate",
      type: "boolean",
      description: "Whether Mailchimp authenticated the campaign. Defaults to true.",
      optional: true,
    },
    autoFooter: {
      label: "Auto footer",
      type: "boolean",
      description: "Automatically append Mailchimp's default footer to the campaign.",
      optional: true,
    },
    inlineCss: {
      label: "Inline css",
      type: "boolean",
      description: "Automatically inline the CSS included with the campaign content.",
      optional: true,
    },
    autoTweet: {
      label: "Auto tweet",
      type: "boolean",
      description: "Automatically tweet a link to the campaign archive page when the campaign is sent.",
      optional: true,
    },
    autoFbPost: {
      label: "Auto fb post",
      type: "any",
      description: "An array of Facebook page ID to auto-post to.",
      optional: true,
    },
    fbComments: {
      label: "FB comments",
      type: "boolean",
      description: "Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to true.",
      optional: true,
    },
    templateId: {
      label: "Template ID",
      type: "integer",
      description: "The ID of the template to use.",
      optional: true,
    },
    opens: {
      label: "Opens",
      type: "boolean",
      description: "Whether to track opens. Defaults to true. Cannot be set to false for variate campaigns.",
      optional: true,
    },
    htmlClicks: {
      label: "HTML clicks",
      type: "boolean",
      description: "Whether to track clicks in the HTML version of the campaign. Defaults to true. Cannot be set to false for variate campaigns.",
      optional: true,
    },
    textClicks: {
      label: "Text clicks",
      type: "boolean",
      description: "Whether to track clicks in the plain-text version of the campaign. Defaults to true. Cannot be set to false for variate campaigns.",
      optional: true,
    },
    goalTracking: {
      label: "Goal tracking",
      type: "boolean",
      description: "Whether to enable Goal tracking.",
      optional: true,
    },
    ecomm360: {
      label: "E-commerce tracking",
      type: "boolean",
      description: "Whether to enable eCommerce360 tracking.",
      optional: true,
    },
    googleAnalytics: {
      label: "Google analytics",
      type: "string",
      description: "The custom slug for Google Analytics tracking (max of 50 bytes).",
      optional: true,
    },
    clicktale: {
      label: "Clicktale",
      type: "string",
      description: "The custom slug for ClickTale tracking (max of 50 bytes).",
      optional: true,
    },
    salesforceCampaign: {
      label: "Salesforce campaign",
      type: "boolean",
      description: "Create a campaign in a connected Salesforce account.",
      optional: true,
    },
    salesforceNotes: {
      label: "Salesforce notes",
      type: "boolean",
      description: "Update contact notes for a campaign based on subscriber email addresses.",
      optional: true,
    },
    capsuleNotes: {
      label: "Capsule notes",
      type: "boolean",
      description: "Update contact notes for a campaign based on subscriber email addresses. Must be using Mailchimp's built-in Capsule integration.",
      optional: true,
    },
    socialImageUrl: {
      label: "Social image url",
      type: "string",
      description: "The url for the header image for the preview card.",
      optional: true,
    },
    socialDescritpion: {
      label: "Social description",
      type: "string",
      description: "A short summary of the campaign to display.",
      optional: true,
    },
    socialTitle: {
      label: "Social title",
      type: "string",
      description: "The title for the preview card. Typically the subject line of the campaign.",
      optional: true,
      options: [
        "active",
        "inactive",
      ],
    },
  },
  async run({ $ }) {

    const payload = removeNullEntries({
      "type": this.type,
      "recipients": {
        "list_id": this.listId,
        "segment_ops": {
          "saved_segment_id": this.savedSegmentId,
          "prebuilt_segment_id": this.prebuiltSegmentId,
          "match": this.segmentMatch,
          "conditions": this.segmentConditions,
        },
      },
      "settings": {
        "subject_line": this.subjectLine,
        "preview_text": this.previewText,
        "title": this.title,
        "from_name": this.fromName,
        "reply_to": this.replyTo,
        "use_conversation": this.useConversation,
        "to_name": this.toName,
        "folder_id": this.folderId,
        "authenticate": this.authenticate,
        "auto_footer": this.autoFooter,
        "inline_css": this.inlineCss,
        "auto_tweet": this.autoTweet,
        "auto_fb_post": this.autoFbPost,
        "fb_comments": this.fbComments,
        "template_id": this.templateId,
      },
      "tracking:": {
        "opens": this.opens,
        "html_clicks": this.htmlClicks,
        "text_clicks": this.textClicks,
        "goal_tracking": this.goalTracking,
        "ecomm360": this.ecomm360,
        "google_analytics": this.googleAnalytics,
        "clicktale": this.clicktale,
        "salesforce": {
          "campaign": this.salesforceCampaign,
          "notes": this.salesforceNotes,
        },
        "capsule": {
          "notes": this.capsuleNotes,
        },
      },
      "social_card": {
        "image_url": this.socialImageUrl,
        "description": this.socialDescritpion,
        "title": this.socialTitle,
      },
    });

    const response = await this.mailchimp.createCampaign($, payload);
    response && $.export("$summary", "Campaign created successfully");
    return response;

  },
};

Configuration

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.
LabelPropTypeDescription
MailchimpmailchimpappThis component uses the Mailchimp app.
TypetypestringSelect a value from the drop down menu:regularplaintextabsplitrssvariate
List IdlistIdstringSelect a value from the drop down menu.
Saved segment IDsavedSegmentIdinteger

The ID for an existing saved segment.

Prebuilt segment IDprebuiltSegmentIdstring

The prebuilt segment ID, if a prebuilt segment has been designated for this campaign.

Segment matchsegmentMatchstringSelect a value from the drop down menu:anyall
Segment conditionssegmentConditionsany

Segment match conditions.

Subject linesubjectLinestring

The subject line for the campaign.

Preview textpreviewTextstring

The preview text for the campaign.

Titletitlestring

The title of the campaign.

From namefromNamestring

The 'from' name on the campaign (not an email address).

Reply toreplyTostring

The reply-to email address for the campaign. Note: while this field is not required for campaign creation, it is required for sending.

Use conversationuseConversationboolean

Use Mailchimp Conversation feature to manage out-of-office replies.

To nametoNamestring

The campaign's custom to name.

Folder IDfolderIdstring

If the campaign is listed in a folder, the ID for that folder.

Authenticateauthenticateboolean

Whether Mailchimp authenticated the campaign. Defaults to true.

Auto footerautoFooterboolean

Automatically append Mailchimp's default footer to the campaign.

Inline cssinlineCssboolean

Automatically inline the CSS included with the campaign content.

Auto tweetautoTweetboolean

Automatically tweet a link to the campaign archive page when the campaign is sent.

Auto fb postautoFbPostany

An array of Facebook page ID to auto-post to.

FB commentsfbCommentsboolean

Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to true.

Template IDtemplateIdinteger

The ID of the template to use.

Opensopensboolean

Whether to track opens. Defaults to true. Cannot be set to false for variate campaigns.

HTML clickshtmlClicksboolean

Whether to track clicks in the HTML version of the campaign. Defaults to true. Cannot be set to false for variate campaigns.

Text clickstextClicksboolean

Whether to track clicks in the plain-text version of the campaign. Defaults to true. Cannot be set to false for variate campaigns.

Goal trackinggoalTrackingboolean

Whether to enable Goal tracking.

E-commerce trackingecomm360boolean

Whether to enable eCommerce360 tracking.

Google analyticsgoogleAnalyticsstring

The custom slug for Google Analytics tracking (max of 50 bytes).

Clicktaleclicktalestring

The custom slug for ClickTale tracking (max of 50 bytes).

Salesforce campaignsalesforceCampaignboolean

Create a campaign in a connected Salesforce account.

Salesforce notessalesforceNotesboolean

Update contact notes for a campaign based on subscriber email addresses.

Capsule notescapsuleNotesboolean

Update contact notes for a campaign based on subscriber email addresses. Must be using Mailchimp's built-in Capsule integration.

Social image urlsocialImageUrlstring

The url for the header image for the preview card.

Social descriptionsocialDescritpionstring

A short summary of the campaign to display.

Social titlesocialTitlestringSelect a value from the drop down menu:activeinactive

Authentication

Mailchimp uses OAuth authentication. When you connect your Mailchimp account, Pipedream will open a popup window where you can sign into Mailchimp and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Mailchimp API.

Pipedream requests the following authorization scopes when you connect your account:

About Mailchimp

Mailchimp is a marketing automation and email marketing platform.

More Ways to Use Mailchimp

Triggers

Link Clicked from the Mailchimp API

Emit new event when a recipient clicks a pre-specified link in an specific campaign.

 
Try it
New Audience from the Mailchimp API

Emit new event when an audience is added to the connected Mailchimp account.

 
Try it
New Campaign from the Mailchimp API

Emit new event when a new campaign is created or sent

 
Try it
New Customer from the Mailchimp API

Emit new event when a new customer is added to a selected store.

 
Try it
New File from the Mailchimp API

Emit new event when a new file is added to the File Manager of the connected Mailchimp account.

 
Try it

Actions

Add Member To Segment with the Mailchimp API

Adds a new member to a static segment. See docs here

 
Try it
Add Note to Subscriber with the Mailchimp API

Adds a new note to an existing subscriber. See docs here

 
Try it
Add Or Remove Members Tags with the Mailchimp API

Add or remove member tags. See docs here

 
Try it
Add or Update Subscriber with the Mailchimp API

Adds a new subscriber to an audience or updates existing subscriber. See docs here

 
Try it
Add Subscriber To Tag with the Mailchimp API

Adds an email address to a tag within an audience. See docs here

 
Try it

Explore Other Apps

1
-
24
of
2,400+
apps by most popular

HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Node
Node
Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.
Python
Python
Anything you can do in Python can be done in a Pipedream Workflow. This includes using any of the 350,000+ PyPi packages available in your Python powered workflows.
OpenAI (ChatGPT)
OpenAI (ChatGPT)
OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular models like ChatGPT, DALL-E, and Whisper.
Premium
Salesforce
Salesforce
Web services API for interacting with Salesforce
Premium
HubSpot
HubSpot
HubSpot's CRM platform contains the marketing, sales, service, operations, and website-building software you need to grow your business.
Premium
Zoho CRM
Zoho CRM
Zoho CRM is an online Sales CRM software that manages your sales, marketing, and support in one CRM platform.
Premium
Stripe
Stripe
Stripe powers online and in-person payment processing and financial solutions for businesses of all sizes.
Shopify
Shopify
Shopify is a complete commerce platform that lets anyone start, manage, and grow a business. You can use Shopify to build an online store, manage sales, market to customers, and accept payments in digital and physical locations.
Premium
WooCommerce
WooCommerce
WooCommerce is the open-source ecommerce platform for WordPress.
Premium
Snowflake
Snowflake
A data warehouse built for the cloud
Premium
MongoDB
MongoDB
MongoDB is an open source NoSQL database management program.
Supabase
Supabase
Supabase is an open source Firebase alternative.
MySQL
MySQL
MySQL is an open-source relational database management system.
PostgreSQL
PostgreSQL
PostgreSQL is a free and open-source relational database management system emphasizing extensibility and SQL compliance.
Premium
AWS
AWS
Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.
Premium
Twilio SendGrid
Twilio SendGrid
Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.
Amazon SES
Amazon SES
Amazon SES is a cloud-based email service provider that can integrate into any application for high volume email automation
Premium
Klaviyo
Klaviyo
Email Marketing and SMS Marketing Platform
Premium
Zendesk
Zendesk
Zendesk is award-winning customer service software trusted by 200K+ customers. Make customers happy via text, mobile, phone, email, live chat, social media.
Notion
Notion
Notion is a new tool that blends your everyday work apps into one. It's the all-in-one workspace for you and your team.
Slack
Slack
Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.
Microsoft Teams
Microsoft Teams
Microsoft Teams has communities, events, chats, channels, meetings, storage, tasks, and calendars in one place.
Schedule
Schedule
Trigger workflows on an interval or cron schedule.