Mailchimp

Manage your Mailchimp audiences, members, and email campaigns.

Add or subscribe a contact to a Mailchimp audience.

Parameters

Parameter	Type	Required	Description
`list_id`	string	Yes	The ID of the Mailchimp audience.
`email`	string	Yes	Subscriber email
`status`	string	No	Whether the contact is subscribed now, or pending until they confirm via email.
`first_name`	string	No	First name
`last_name`	string	No	Last name

Response

{
  "email_address": "user@example.com",
  "id": "abc123xyz789",
  "status": "active",
  "unique_email_id": "abc123xyz789"
}

Create a new Mailchimp audience with contact and sender defaults.

Parameters

Parameter	Type	Required	Description
`name`	string	Yes	Audience name
`permission_reminder`	string	Yes	A short note reminding subscribers why they're receiving your emails.
`from_name`	string	Yes	Default from name
`from_email`	string	Yes	Default from email
`company`	string	Yes	Company name
`address1`	string	Yes	Street address
`city`	string	Yes	City
`country`	string	Yes	Country
`email_type_option`	boolean	No	Set to true to let subscribers choose between HTML and plain-text emails.

Response

{
  "id": "abc123xyz789",
  "name": "Sample Item",
  "web_id": 1
}

Create a new campaign for a given audience.

Parameters

Parameter	Type	Required	Description
`list_id`	string	Yes	The ID of the Mailchimp audience.
`subject`	string	Yes	Campaign subject
`from_name`	string	Yes	Sender name
`reply_to`	string	Yes	Reply-to email
`type`	string	No	The kind of email campaign to create.

Response

{
  "id": "abc123xyz789",
  "status": "active",
  "type": "view",
  "web_id": 1
}

Create a tag and apply it to a subscriber.

Parameters

Parameter	Type	Required	Description
`list_id`	string	Yes	The ID of the Mailchimp audience.
`email`	string	Yes	Subscriber email
`tag_name`	string	Yes	Tag name

Response

{
  "tags": [
    {
      "id": 1,
      "name": "Sample Item"
    }
  ]
}

List your Mailchimp audiences.

Parameters

Parameter	Type	Required	Description
`count`	number	No	Maximum number of audiences to return

Response

{
  "results": [
    {
      "id": "contact123",
      "properties": {
        "email": "user@example.com"
      }
    }
  ]
}

Remove a subscriber from a Mailchimp audience.

Parameters

Parameter	Type	Required	Description
`list_id`	string	Yes	The ID of the Mailchimp audience.
`email`	string	Yes	Subscriber email

Response

{
  "deleted": true
}

Send a campaign that is ready to be delivered.

Parameters

Parameter	Type	Required	Description
`campaign_id`	string	Yes	The ID of the Mailchimp campaign to send.

Response

{
  "complete": true
}

Update the subscription status of a member in an audience.

Parameters

Parameter	Type	Required	Description
`list_id`	string	Yes	The ID of the Mailchimp audience.
`email`	string	Yes	Subscriber email
`status`	string	Yes	The subscription status to set for this contact.

Response

{
  "email_address": "user@example.com",
  "id": "abc123xyz789",
  "status": "active"
}