Docs
Open Lodol
DocumentationIntegrationsAPI

Mailchimp

App · Email Marketing · 9 actions

Manage your Mailchimp audiences, members, and email campaigns.

Actions

ActionWhat it does
Add member to audienceAdd or subscribe a contact to a Mailchimp audience.
Create a Mailchimp audienceCreate a new Mailchimp audience with contact and sender defaults.
Create a Mailchimp campaignCreate a new campaign for a given audience.
List Mailchimp audiencesList your Mailchimp audiences.
Remove member from audienceRemove a subscriber from a Mailchimp audience.
Send a Mailchimp campaignSend a campaign that is ready to be delivered.
Set Mailchimp campaign contentSet the HTML and/or plain-text content of a campaign so it is ready to send.
Tag a Mailchimp memberCreate a tag and apply it to a subscriber.
Update member statusUpdate the subscription status of a member in an audience.

Add member to audience

Add or subscribe a contact to a Mailchimp audience.

Inputs

Audience IDlist_idtextRequired
The ID of the Mailchimp audience.
EmailemailtextRequired
Subscriber email
Subscription statusstatustext
Whether the contact is subscribed now, or pending until they confirm via email.One of: subscribed, pending (Pending (send a confirmation email first)), unsubscribed, cleaned (Cleaned (invalid or bounced)). Default: subscribed.
First namefirst_nametext
First name
Last namelast_nametext
Last name

Outputs

email_addresstext
Member's email address
idtext
Member ID (MD5 hash of lowercase email address)
statustext
Subscription status
unique_email_idtext
Unique identifier for this email address
Example output
{
  "email_address": "user@example.com",
  "id": "abc123xyz789",
  "status": "subscribed",
  "unique_email_id": "abc123xyz789"
}

Create a Mailchimp audience

Create a new Mailchimp audience with contact and sender defaults.

Inputs

NamenametextRequired
Audience name
Permission reminderpermission_remindertextRequired
A short note reminding subscribers why they're receiving your emails.
From namefrom_nametextRequired
Default from name
From emailfrom_emailtextRequired
Default from email
CompanycompanytextRequired
Company name
Street addressaddress1textRequired
Street address
CitycitytextRequired
City
State / regionstatetextRequired
State or region. Mailchimp requires this for the audience contact address.
ZIP / postal codeziptextRequired
ZIP or postal code. Mailchimp requires this for the audience contact address.
CountrycountrytextRequired
Country
Email type optionemail_type_optiontrue/false
Set to true to let subscribers choose between HTML and plain-text emails.Default: true.

Outputs

idtext
Mailchimp audience/list ID
nametext
Audience name as displayed in Mailchimp
web_idnumber
Web-accessible ID for the audience
Example output
{
  "id": "abc123xyz789",
  "name": "Newsletter Subscribers",
  "web_id": 1
}

Create a Mailchimp campaign

Create a new campaign for a given audience.

Inputs

Audience IDlist_idtextRequired
The ID of the Mailchimp audience.
SubjectsubjecttextRequired
Campaign subject
From namefrom_nametextRequired
Sender name
Reply toreply_totextRequired
Reply-to email
Campaign typetypetext
The kind of email campaign to create.One of: regular (Regular (standard HTML email)), plaintext (Plain-text email). Default: regular.

Outputs

idtext
Mailchimp campaign ID
statustext
Current campaign status
typetext
Campaign type
web_idnumber
Web-accessible ID for the campaign
Example output
{
  "id": "abc123xyz789",
  "status": "save",
  "type": "regular",
  "web_id": 1
}

List Mailchimp audiences

List your Mailchimp audiences.

Inputs

Countcountnumber
Maximum number of audiences to return

Outputs

resultslist
List of results
Example output
{
  "results": [
    {
      "id": "abc123xyz789",
      "name": "Newsletter Subscribers",
      "stats": {
        "member_count": 42
      },
      "web_id": 1
    }
  ]
}

Remove member from audience

Remove a subscriber from a Mailchimp audience.

Inputs

Audience IDlist_idtextRequired
The ID of the Mailchimp audience.
EmailemailtextRequired
Subscriber email

Outputs

deletedtrue/false
Indicates whether the member was successfully deleted
Example output
{
  "deleted": true
}

Send a Mailchimp campaign

Send a campaign that is ready to be delivered.

Inputs

Campaign IDcampaign_idtextRequired
The ID of the Mailchimp campaign to send.

Outputs

completetrue/false
Indicates whether the campaign was successfully sent
Example output
{
  "complete": true
}

Set Mailchimp campaign content

Set the HTML and/or plain-text content of a campaign so it is ready to send.

Inputs

Campaign IDcampaign_idtextRequired
The ID of the Mailchimp campaign to set content for.
HTML contenthtmltext
Full HTML body of the email. Provide this and/or plain-text content.
Plain-text contentplain_texttext
Plain-text body of the email. Provide this and/or HTML content.

Outputs

htmltext
The HTML content set on the campaign
plain_texttext
The plain-text content set on the campaign
Example output
{
  "html": "<p>This is a test campaign. Please ignore.</p>",
  "plain_text": "This is a test campaign. Please ignore."
}

Tag a Mailchimp member

Create a tag and apply it to a subscriber.

Inputs

Audience IDlist_idtextRequired
The ID of the Mailchimp audience.
EmailemailtextRequired
Subscriber email
Tag nametag_nametextRequired
Tag name

Outputs

tagslist
Array of all tags assigned to this member
Example output
{
  "tags": [
    {
      "id": 1,
      "name": "VIP"
    }
  ]
}

Update member status

Update the subscription status of a member in an audience.

Inputs

Audience IDlist_idtextRequired
The ID of the Mailchimp audience.
EmailemailtextRequired
Subscriber email
New statusstatustextRequired
The subscription status to set for this contact.One of: subscribed, pending (Pending (send a confirmation email first)), unsubscribed, cleaned (Cleaned (invalid or bounced)).

Outputs

email_addresstext
Member's email address with updated status
idtext
Member ID (MD5 hash of lowercase email address)
statustext
Updated subscription status
Example output
{
  "email_address": "user@example.com",
  "id": "abc123xyz789",
  "status": "unsubscribed"
}

Mailcheck

Previous Page

MailerLite

Next Page

On this page

ActionsAdd member to audienceCreate a Mailchimp audienceCreate a Mailchimp campaignList Mailchimp audiencesRemove member from audienceSend a Mailchimp campaignSet Mailchimp campaign contentTag a Mailchimp memberUpdate member status