MailChimp

1. Overview

Mailchimp is a leading marketing automation platform and email marketing service. It helps businesses manage their mailing lists, create email marketing campaigns, and automate communications with their audience.

With the GoInsight Mailchimp node, you can seamlessly integrate email marketing and audience management into your automated workflows. This allows you to perform a wide range of tasks, including:

• Campaign Management: Retrieve, send, replicate, and delete your email campaigns directly from a workflow.
• Audience Management: Add new subscribers (members) to your lists, retrieve their details, update their information, or remove them.
• Segmentation: Manage member tags to better segment and target your audience.
• List Insights: Fetch information about interest groups within your lists.

2. Prerequisites

Before using this node, you need to have a valid Mailchimp account. You will also need the necessary permissions within your Mailchimp account to generate an API key for authentication.

3. Credentials

For a detailed guide on how to obtain and configure your credentials, please refer to our official documentation: Credentials Configuration Guide.

4. Supported Operations

Summary

The Mailchimp node provides a comprehensive set of operations centered around managing your Campaigns and list Members. You can perform full lifecycle management for these resources, from creation and retrieval to updating and deletion.

Operation Details

Create a Member

Creates a new member in the specified MailChimp list.

Input Parameters:

• DataCenter: Data element center
• ListId: The ID of the list to add the member to
• EmailAddress: The email address of the member to add

Optional Parameters:

• Status: The subscription status (subscribed, unsubscribed, cleaned, pending, transactional)
• MergeFields: Merge fields for the member (optional)
• Interests: Interest groups for the member (optional)

Output:

• MemberId (string): The unique identifier assigned to the member by MailChimp.
• UniqueEmailId (string): A unique email-based ID returned by MailChimp.
• EmailAddress (string): The email address of the created member.
• MemberStatus (string): The subscription status of the member.
• StatusCode (number): HTTP status code returned by the MailChimp API (201 for successful creation).
• ErrorMessage (string): Error message if the request failed, empty otherwise.

Create a Member Tag

Adds tags to the specified member in the MailChimp list.

Input Parameters:

• DataCenter: Data element center
• ListId: The ID of the list containing the member
• SubscriberHash: The MD5 hash of the member's email address
• Tags: List of tags to add

Output:

• Added (bool): Indicates whether the tag was successfully added to the member.
• StatusCode (number): HTTP status code of the tag addition operation; -1 indicates parameter validation error; 500 indicates an exception during the request.
• ErrorMessage (string): Error message if the tag addition fails or parameter validation fails; empty if successful.

Delete a Campaign

Deletes a specific MailChimp campaign by its ID.

Input Parameters:

• DataCenter: Data element center
• CampaignId: The ID of the campaign to delete

Output:

• Deleted (bool): Whether the campaign was successfully deleted
• StatusCode (number): HTTP status code of the deletion operation; -1 indicates parameter validation error; 500 indicates an exception during the request.
• ErrorMessage (string): Error message if the deletion fails or parameter validation fails; empty if successful.

Delete a Member

Deletes a member from the specified MailChimp list.

Input Parameters:

• DataCenter: Data element center
• ListId: The ID of the list to delete the member from
• SubscriberHash: The MD5 hash of the member's email address

Output:

• Deleted (bool): Whether the member was deleted successfully.
• StatusCode (number): HTTP status code of the deletion operation; -1 indicates parameter validation error; 500 indicates an exception during the request.
• ErrorMessage (string): Error message if the deletion fails or parameter validation fails; empty if successful.

Delete a Member Tag

Removes tags from the specified member in the MailChimp list.

Input Parameters:

• DataCenter: Data element center
• ListId: The ID of the list containing the member
• SubscriberHash: The MD5 hash of the member's email address
• Tags: List of tags to remove

Output:

• TagsRemoved (bool): Whether the tags were removed successfully.
• StatusCode (number): HTTP status code of the tag removal operation; -1 indicates parameter validation error; 500 indicates an exception during the request.
• ErrorMessage (string): Error message if the tag removal fails or parameter validation fails; empty if successful.

Get Many Campaigns

Retrieves a list of MailChimp campaigns with default pagination settings.

Input Parameters:

• DataCenter: Data element center

Output:

• Campaigns (object-array): A list of campaign objects returned by MailChimp. Each object includes fields like id, create_time, status, emails_sent, etc.
• TotalItems (number): The total number of campaigns in the account.
• StatusCode (number): HTTP status code of the retrieval operation; -1 indicates parameter validation error; 500 indicates an exception during the request.
• ErrorMessage (string): Error message if the retrieval fails or parameter validation fails; empty if successful.

Get Many List Groups

Retrieves a list of groups for the specified MailChimp list.

Input Parameters:

• DataCenter: Data element center
• ListId: The ID of the list to get groups for

Output:

• Groups (object-array): A list of group objects returned by MailChimp.
• TotalItems (number): The total number of groups in the list.
• StatusCode (number): HTTP status code of the retrieval operation; -1 indicates parameter validation error; 500 indicates an exception during the request.
• ErrorMessage (string): Error message if the retrieval fails or parameter validation fails; empty if successful.

Get Many Members

Retrieves a list of members from the specified MailChimp list with pagination support.

Input Parameters:

• DataCenter: Data element center
• ListId: The ID of the list to get members from

Optional Parameters:

• Count: Number of members to return (default 10, max 1000)
• Offset: Offset for pagination (default 0)

Output:

• Members (object-array): A list of member objects returned by MailChimp.
• TotalItems (number): The total number of members in the list.
• StatusCode (number): HTTP status code of the retrieval operation; -1 indicates parameter validation error; 500 indicates an exception during the request.
• ErrorMessage (string): Error message if the retrieval fails or parameter validation fails; empty if successful.

Get a Campaign

Retrieves a specific MailChimp campaign by its ID.

Input Parameters:

• DataCenter: Data element center
• CampaignId: The ID of the campaign to retrieve

Output:

• CampaignId (string): The unique identifier of the campaign.
• WebId (number): A unique numeric ID for the campaign.
• Type (string): Type of campaign (e.g., "regular", "plaintext", "absplit").
• CreateTime (string): The time the campaign was created in ISO 8601 format.
• ArchiveUrl (string): The URL to view the campaign archive.
• Status (string): Current status of the campaign (e.g., "saved", "paused", "sending", "sent").
• ListId (string): The MailChimp list ID associated with the campaign's recipients.
• SubjectLine (string): The subject line of the campaign email.
• Title (string): The title of the campaign.
• FromName (string): The "from" name displayed in the campaign email.
• ReplyTo (string): The reply-to email address for the campaign.
• StatusCode (number): HTTP status code returned by the MailChimp API (200 for success, 404 if not found, etc.).
• ErrorMessage (string): An error message if the request failed, empty otherwise.

Get a Member

Retrieves a member from the specified MailChimp list.

Input Parameters:

• DataCenter: Data element center
• ListId: The ID of the list to get the member from
• SubscriberHash: The MD5 hash of the member's email address

Output:

• MemberId (string): The unique identifier assigned to the member by MailChimp.
• UniqueEmailId (string): A unique email-based ID returned by MailChimp.
• EmailAddress (string): The email address of the retrieved member.
• MemberStatus (string): The subscription status of the member.
• StatusCode (number): HTTP status code of the retrieval operation; -1 indicates parameter validation error; 500 indicates an exception during the request.
• ErrorMessage (string): Error message if the retrieval fails or parameter validation fails; empty if successful.

Send a Campaign

Sends the specified MailChimp campaign.

Input Parameters:

• DataCenter: Data element center
• CampaignId: The ID of the campaign to send

Output:

• Sent (bool): Whether the campaign was sent successfully.
• StatusCode (number): HTTP status code of the send operation; -1 indicates parameter validation error; 500 indicates an exception during the request.
• ErrorMessage (string): Error message if the send fails or parameter validation fails; empty if successful.

Replicate a Campaign

Replicates a specific MailChimp campaign by its ID.

Input Parameters:

• DataCenter: Data element center
• CampaignId: The ID of the campaign to replicate

Output:

• NewCampaignId (string): The unique ID of the newly created campaign.
• StatusCode (number): HTTP status code of the replication operation; -1 indicates parameter validation error; 500 indicates an exception during the request.
• ErrorMessage (string): Error message if the replication fails or parameter validation fails; empty if successful.

Resend a Campaign

Creates a Resend to Non-Openers version of the specified MailChimp campaign.

Input Parameters:

• DataCenter: Data element center
• CampaignId: The ID of the campaign to create a resend version for

Output:

• IsResent (bool): Indicates whether the campaign was successfully resent (true when MailChimp returns HTTP 204).
• StatusCode (number): HTTP status code of the creation operation; -1 indicates parameter validation error; 500 indicates an exception during the request.
• ErrorMessage (string): Error message if the creation fails or parameter validation fails; empty if successful.

Update a Member

Updates the specified member in the MailChimp list.

Input Parameters:

• DataCenter: Data element center
• ListId: The ID of the list containing the member
• SubscriberHash: The MD5 hash of the member's email address

Optional Parameters:

• EmailAddress: New email address for the member (optional)
• Status: New subscription status (subscribed, unsubscribed, cleaned, pending, transactional) (optional)
• MergeFields: New merge fields for the member (optional)
• Interests: New interest groups for the member (optional)

Output:

• Member (object): The updated member object.
• StatusCode (number): HTTP status code of the update operation; -1 indicates parameter validation error; 500 indicates an exception during the request.
• ErrorMessage (string): Error message if the update fails or parameter validation fails; empty if successful.

5. Example Usage

This section will guide you through creating a simple workflow to add a new subscriber to a Mailchimp list using the Create a Member action.

The workflow will consist of three nodes: Start -> Mailchimp: Create a Member -> Answer.

1. Add the Mailchimp Node

• On the workflow canvas, click the + button to add a new node.
• In the pop-up panel, select the "Tools" tab.
• Find and select Mailchimp from the list of tools.
• In the list of supported operations for Mailchimp, click on Create a Member. This will add the corresponding node to your canvas.

2. Configure the Node

• Click on the newly added Create a Member node to open its configuration panel on the right.
• Credential Configuration: At the top of the panel, find the credentials field. Click the dropdown menu and select your pre-configured Mailchimp credential.
• Parameter Configuration: Fill in the required input parameters for the action.
  • DataCenter: Enter your Mailchimp account's data center. This is the part of the URL you see when logged in, such as us19.
  • ListId: Provide the unique ID for the audience (list) you want to add the member to. You can find this in your list's settings in Mailchimp.
  • EmailAddress: Enter the email address of the new subscriber, for example, new.subscriber@example.com.
  • Status (Optional): You can leave this as the default subscribed or change it to another status like pending.
  • MergeFields (Optional): If you use merge fields (like First Name, Last Name), you can provide them here as a JSON object. For example: {"FNAME": "John", "LNAME": "Doe"}.

3. Run and Validate

• Once all required parameters are correctly filled, any error indicators on the workflow canvas will disappear.
• Click the "Test Run" button in the top-right corner of the canvas to execute the workflow.
• After a successful execution, you can click the logs icon in the top-right corner to view the detailed inputs and outputs of the node, confirming that the member was created successfully.

After completing these steps, your workflow is fully configured. When executed, it will add a new member to your specified Mailchimp list.

6. FAQs

Q: How do I find my Mailchimp DataCenter and ListId?

A: You can find these details within your Mailchimp account:

• DataCenter: Log in to your Mailchimp account. The URL in your browser's address bar will look something like https://us19.admin.mailchimp.com/. The us19 part is your data center.
• ListId: Navigate to the "Audience" section, select the desired audience (list), go to "Settings", and then click "Audience name and defaults". The List ID will be displayed there.

Q: What is a SubscriberHash and how do I generate it?

A: The SubscriberHash is a unique identifier for a list member, which Mailchimp uses in its API. It is the MD5 hash of the subscriber's email address, converted to all lowercase. Many online tools or programming libraries can generate an MD5 hash for you. For example, the hash for user@example.com is b58996c504c5638798eb6b511e6f49af.

Q: I'm receiving a 401 Unauthorized error. What should I do?

A: A 401 error typically indicates a problem with your API key. Please check the following:

• Ensure the API key entered in your GoInsight credential is correct and has not expired.
• Verify that the API key has the necessary permissions to perform the requested actions on your Mailchimp account.

7. Official Documentation

For more in-depth information and advanced use cases, please refer to the Mailchimp Marketing API Documentation.