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

This node primarily operates on resources such as Member, Member Tag, Campaign, and List Group. The following table outlines the available operations for each resource:

Resource Operation Description
Member Create a Member Creates a new member in the specified MailChimp list.
Member Delete a Member Deletes a member from the specified MailChimp list.
Member Get Many Members Retrieves a list of members from the specified MailChimp list with pagination support.
Member Get a Member Retrieves a member from the specified MailChimp list.
Member Update a Member Updates the specified member in the MailChimp list.
Member Tag Create a Member Tag Adds tags to the specified member in the MailChimp list.
Member Tag Delete a Member Tag Removes tags from the specified member in the MailChimp list.
Campaign Delete a Campaign Deletes a specific MailChimp campaign by its ID.
Campaign Get Many Campaigns Retrieves a list of MailChimp campaigns with default pagination settings.
Campaign Get a Campaign Retrieves a specific MailChimp campaign by its ID.
Campaign Send a Campaign Sends the specified MailChimp campaign.
Campaign Replicate a Campaign Replicates a specific MailChimp campaign by its ID.
Campaign Resend a Campaign Creates a Resend to Non-Openers version of the specified MailChimp campaign.
List Group Get Many List Groups Retrieves a list of groups for the specified MailChimp list.

Operation Details

Create a Member

Creates a new member in the specified MailChimp list.

Input Parameters:

  • DataCenter: MailChimp data center region identifier (e.g., us1, us19, us21). How to find: Look at your MailChimp dashboard URL - if URL is https://us19.admin.mailchimp.com, enter us19. Default: us1 (most common for US accounts).
  • ListId: The unique ID of the target MailChimp audience list. How to get: 1) Via API: Call the Get Lists Action to retrieve all list IDs. 2) Manual: MailChimp Dashboard > Audience > Settings > Audience name and defaults > Audience ID. Format: 10-character alphanumeric string (e.g., a1b2c3d4e5).
  • EmailAddress: The email address for the new member.

Options:

  • Status: Subscription status for the member. Accepted values: subscribed (Active subscriber, will receive campaigns), unsubscribed (User has opted out), cleaned (Invalid/bounced email address, MailChimp auto-managed), pending (Awaiting double opt-in confirmation), transactional (Only receives transactional emails, not campaigns). Selection Guide: For manual subscription forms use 'subscribed'; For double opt-in confirmation use 'pending'; For bulk import of existing users use 'subscribed' (ensure authorization obtained); For transactional emails only use 'transactional'. Default: subscribed
  • MergeFields: Additional member information using MailChimp merge tags. Common merge tags: FNAME (First name), LNAME (Last name), PHONE (Phone number), ADDRESS (Mailing address), BIRTHDAY (MM/DD format). Full list: MailChimp Dashboard > Audience > Settings > Audience fields and |MERGE| tags. Example: {"FNAME": "John", "LNAME": "Doe", "PHONE": "+1-555-0100"}
  • Interests: Purpose: Subscriber's interest preferences (e.g., subscribe to 'Product Updates' but not 'Promotional Campaigns'). Format: Object where keys are interest group IDs and values are boolean (true=subscribed, false=unsubscribed). How to get group IDs: Call Get Interest Categories Action or check MailChimp Audience > Manage Contacts > Groups. Example: {"a1b2c3d4e5": true, "f6g7h8i9j0": false}

Output:

  • Member (object): The created member object. Core fields:
  • id (string): Unique member ID (MD5 hash of lowercase email)
  • email_address (string): Member's email address
  • status (string): Subscription status (subscribed/unsubscribed/cleaned/pending/transactional)
  • merge_fields (object): Custom fields (e.g., {"FNAME": "John", "LNAME": "Doe"})
  • interests (object): Interest group preferences (e.g., {"groupId": true})
  • timestamp_signup (string): ISO 8601 signup time
  • timestamp_opt (string): ISO 8601 opt-in confirmation time
  • last_changed (string): ISO 8601 last modified time
  • list_id (string): Parent list ID
  • unique_email_id (string): Unique identifier for email
  • StatusCode (number): Operation status code: 200=Success (check ErrorMessage for business errors), -1=Parameter validation error, 500=System error (may retry).
  • OriginalStatusCode (number): The original HTTP status code returned by the upstream API. Use for debugging.
  • ErrorMessage (string): Detailed error message if any error occurred. Empty string if the operation succeeded.

Delete a Member

Deletes a member from the specified MailChimp list.

Input Parameters:

  • DataCenter: Mailchimp server region prefix (e.g., 'us1', 'us19'). Extract from API Key format '-' or get from Account Settings > API Keys.
  • ListId: The ID of the Mailchimp list (Audience ID) to delete the member from. Get via 'Get All Lists' API or from Mailchimp web: Audience > Settings > Audience ID. Format: 10 characters (e.g., 'a1b2c3d4e5').
  • SubscriberHash: The MD5 hash of the member's email address (lowercase). Calculation: 1) Convert email to lowercase (User@Example.com -> user@example.com), 2) Calculate MD5 hash (Python: hashlib.md5(email.lower().encode()).hexdigest()). Example: 'john@example.com' -> 'd9e96b5e0e1e71c9c3e2e88b4e4e5e5f'. Tip: Use 'Search Members' API to get existing member hashes.

Output:

  • Deleted (bool): Whether the member was deleted successfully. 'true' = deletion succeeded, 'false' = deletion failed (see ErrorMessage for details).
  • StatusCode (number): Operation status code: 200=Success (check ErrorMessage for business errors), -1=Parameter validation error, 500=System error (may retry).
  • ErrorMessage (string): Detailed error message if any error occurred. Empty string if the operation succeeded. Common errors: 'Resource Not Found' (member/list doesn't exist), 'Invalid Resource' (incorrect SubscriberHash format), 'Forbidden' (insufficient API key permissions).
  • OriginalStatusCode (number): The original HTTP status code returned by the upstream API. Use for debugging. 204=Deletion succeeded, 404=Member not found, 401=Authentication failed, 403=Forbidden.

Get Many Members

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

Input Parameters:

  • DataCenter: Mailchimp data center code (e.g., us1, us19). Check your Mailchimp account settings to find your data center. Default is us1.
  • ListId: The unique identifier of the list to retrieve members from. You can obtain this ID via the 'Get Lists' workflow or from the list settings page in your Mailchimp dashboard. Example format: a1b2c3d4e5

Options:

  • Count: Number of members to return per page (default 10, max 1000). For the first page, use 10 or your desired count.
  • Offset: Skip the first N records for pagination. For the first page, use 0. For the second page, use the value of Count. For the third page, use Count * 2, and so on.

Output:

  • Response (object): Complete response object containing:
  • Members (array): List of member objects. Each member contains:
    • id (string): Member unique identifier
    • unique_email_id (string): Unique email ID for deduplication
    • email_address (string): Member's email address
    • status (string): Member status (subscribed/unsubscribed/cleaned/pending)
    • merge_fields (object): Custom merge fields
    • stats (object): Member statistics
    • timestamp_signup (string): Signup timestamp
    • timestamp_opt (string): Opt-in timestamp
  • TotalItems (number): Total number of members in the list
  • HasMore (boolean): Whether there are more pages available
  • NextOffset (number): Offset value for retrieving the next page
  • StatusCode (number): Operation status code: 200=Success (check ErrorMessage for business errors), -1=Parameter validation error, 500=System error (may retry).
  • ErrorMessage (string): Detailed error message if any error occurred. Empty string if the operation succeeded.
  • OriginalStatusCode (number): The original HTTP status code returned by the upstream API. Use for debugging.

Get a Member

Retrieves a member from the specified MailChimp list.

Input Parameters:

  • DataCenter: Mailchimp data center code (e.g., us1, us19, eu1). Used to construct API URL (https://.api.mailchimp.com). Find it in your Mailchimp account URL or API Keys page.
  • ListId: The unique ID of the Mailchimp list (10-character string). Obtain via 'Get All Lists' API or in Mailchimp dashboard: Audience > Settings > Audience name and defaults.
  • SubscriberHash: MD5 hash of the member's email address (32-character lowercase hex string). Calculate by: 1) Convert email to lowercase, 2) Compute MD5 hash. Example Python code: import hashlib; hashlib.md5('user@example.com'.lower().encode()).hexdigest(). Or obtain from 'Search Members' API response.

Output:

  • Member (object): Complete member object returned by Mailchimp API. Key fields include: id (member unique ID), unique_email_id (email-based ID), email_address (member email), status (subscription status: subscribed/unsubscribed/cleaned/pending), merge_fields (custom fields like FNAME/LNAME), interests (interest groups), stats (engagement statistics), timestamp_signup (signup time), timestamp_opt (opt-in time), ip_signup (signup IP), ip_opt (opt-in IP), location (geographic data), tags (member tags). Empty object {} if member not found or error occurred.
  • StatusCode (number): Operation status code: 200=Success (check ErrorMessage for business errors), 500=System error (network timeout/connection failure, may retry).
  • ErrorMessage (string): Detailed error message if any error occurred. Format: 'Mailchimp API Error (XXX):
    ' for business errors (4xx/5xx), 'Network error:
    ' for connection issues, 'Request timed out after 30 seconds' for timeout. Empty string if operation succeeded.
  • OriginalStatusCode (number): The original HTTP status code returned by the Mailchimp API. Use for debugging. Common values: 200 (success), 404 (member not found), 401 (invalid credentials), 400 (invalid parameters), 500 (Mailchimp server error). Default 0 if request not sent.

Update a Member

Updates the specified member in the MailChimp list.

Input Parameters:

  • DataCenter: Mailchimp data center prefix (e.g., 'us1', 'us19', 'us21'). You can find this in your API key or by checking the URL when logged into Mailchimp (e.g., https://us19.admin.mailchimp.com/).
  • ListId: The unique ID of the Mailchimp list (audience). You can obtain this from the Get_Lists action or from your Mailchimp dashboard (Audience > Settings > Audience name and defaults).
  • SubscriberHash: The MD5 hash of the member's email address. This is a unique identifier for the member. You can get this from the Get_Member or List_Members action response, or calculate it using: md5(lowercase(email_address)).

Options:

  • EmailAddress: New email address for the member (optional). Ensure the new email is valid and not already in the list.
  • Status: Subscription status of the member (optional). Options:
  • subscribed: Active subscriber (can receive campaigns)
  • unsubscribed: Opted out
  • cleaned: Bounced/invalid email
  • pending: Awaiting double opt-in confirmation
  • transactional: Can only receive transactional emails (not marketing campaigns)
  • MergeFields: Custom merge fields (subscriber data) to update (optional). Common fields:
  • FNAME: First name
  • LNAME: Last name
  • PHONE: Phone number
  • BIRTHDAY: Birthday (MM/DD format)

You can get the full list of available merge tags from the Get_List_Merge_Fields action or your Mailchimp list settings.

  • Interests: Interest group preferences (key-value pairs) (optional). Keys are interest IDs (obtained from Get_List_Interest_Categories action), values are booleans indicating subscription status.

Example: {"interest_id_1": true, "interest_id_2": false}

Output:

  • Member (object): The updated member object. Key fields:
  • id (string): Unique member ID
  • email_address (string): Member's email
  • status (string): Current subscription status
  • merge_fields (object): Custom data fields
  • interests (object): Interest group subscriptions
  • last_changed (string): ISO 8601 timestamp of last update
  • StatusCode (number): Operation status code: 200=Success (check ErrorMessage for business errors), -1=Parameter validation error, 500=System error (may retry).
  • ErrorMessage (string): Detailed error message if any error occurred. Empty string if the operation succeeded.
  • OriginalStatusCode (number): The original HTTP status code returned by the upstream API. Use for debugging.

Create a Member Tag

Adds tags to the specified member in the MailChimp list.

Input Parameters:

  • DataCenter: Mailchimp data center prefix (e.g., 'us19', 'us1'). How to find: Method 1 - From API Key (recommended): API Key format is 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx-us19', where the part after '-' (e.g., 'us19') is the DataCenter. Method 2 - From login URL: After logging in, check the browser address bar 'https://us19.admin.mailchimp.com/...', where 'us19' is the DataCenter. Common values: us1, us2, us3...us20 (USA), au1 (Australia), etc. Note: This parameter is usually fixed; recommend setting it as a default value in the workflow.
  • ListId: The unique identifier for the audience list. How to get: 1. Log in to Mailchimp. 2. Left menu 'Audience' -> select target audience. 3. Click 'Settings' -> 'Audience name and defaults'. 4. The 'Audience ID' field on the right side of the page is the ListId. Format: 10-character alphanumeric combination, e.g., 'a1b2c3d4e5'. Or get via API: Call 'Get All Lists' interface, select from returned 'lists[].id'.
  • SubscriberIdentifier: Member identifier. Supports two formats: 1. Email address (recommended): Directly enter the email, e.g., 'user@example.com'. System will automatically convert to Hash. 2. MD5 Hash: If Hash is already known (e.g., obtained from other interfaces), can be used directly. Format: 32-character lowercase hexadecimal string. Note: Email is case-insensitive and will be automatically converted to lowercase.
  • Tags: List of tag names to operate on (string array). Format requirements: Each tag is a string type. Tag name length: 1-100 characters. Spaces and special characters allowed (e.g., 'VIP Client', 'Tier-1'). Case-insensitive ('vip' and 'VIP' are treated as the same tag). Quantity limit: Recommend single operation <= 10 tags. Mailchimp API has no hard limit, but too many may cause timeout. Example: ['VIP', 'Newsletter Subscriber', 'Event-2024'].

Options:

  • TagStatus: Tag status. Determines whether to add or remove tags. Available values: 'active': Add tag to member (default). 'inactive': Remove tag from member. Note: If other values are entered, system will automatically use default value 'active'.

Output:

  • Added (bool): Whether the tag operation was successful. True: Mailchimp API returned 204 No Content (operation successful). False: Operation failed, see ErrorMessage for details. Note: Even if successful, returns True if tag already exists (idempotency).
  • StatusCode (number): Operation status code: 200=Success (check ErrorMessage for business errors), -1=Parameter validation error, 500=System error (may retry).
  • OriginalStatusCode (number): The original HTTP status code returned by the upstream API. Use for debugging.
  • ErrorMessage (string): Detailed error message if any error occurred. Empty string if the operation succeeded. Common errors: 'Resource Not Found': Member does not exist (check if SubscriberIdentifier is correct). 'Invalid Resource': ListId or DataCenter is incorrect. 'Forgotten Email Not Subscribed': Member has unsubscribed and been forgotten (GDPR). '400 Bad Request': Tags parameter format error. Network errors: 'Network or System Error: ...': Network timeout or connection failure (can retry).

Delete a Member Tag

Removes tags from the specified member in the MailChimp list.

Input Parameters:

  • DataCenter: Your Mailchimp account's data center identifier (e.g., us1, us19, eu1). Find it in your Mailchimp dashboard URL: if the URL is https://us19.admin.mailchimp.com/..., your data center is us19.
  • ListId: The unique identifier of the Mailchimp list (Audience ID). How to get: Call 'Get All Lists' or 'Search Lists' action, or find it in Mailchimp web dashboard -> Audience -> Settings -> Audience ID.
  • SubscriberHash: The lowercase MD5 hash of the member's email address. How to calculate: 1) Lowercase the email (User@Example.com -> user@example.com), 2) Calculate MD5 hash. Example: user@example.com -> b58996c504c5638798eb6b511e6f49af. OR you can use the 'Search Member' action first to get the hash automatically.
  • Tags: List of tag names to remove from the member. Note: Tags are removed by setting their status to 'inactive' via Mailchimp API. Tag names are case-sensitive.

Output:

  • TagsRemoved (bool): Whether all tags were removed successfully. true = all tags removed; false = operation failed (check ErrorMessage for details).
  • StatusCode (number): Operation status code: 200=Success (check ErrorMessage for business errors), -1=Parameter validation error, 500=System error (may retry).
  • ErrorMessage (string): Detailed error message if any error occurred. Empty string if the operation succeeded.
  • OriginalStatusCode (number): The original HTTP status code returned by the upstream API. Use for debugging. Common values: 204 (success), 400 (invalid parameters), 401 (authentication failed), 404 (list/member not found), 429 (rate limited).

Delete a Campaign

Deletes a specific MailChimp campaign by its ID.

Input Parameters:

  • DataCenter: MailChimp data center identifier, typically a 2-3 character alphanumeric code (e.g., us1, us19, eu2). You can obtain it from: 1) Your MailChimp dashboard URL (https://.admin.mailchimp.com); 2) The suffix of your API Key (format: xxxxxxxx-us19); 3) The 'dc' field returned by MailChimp Metadata API. Common values: us1, us2, us19, eu2, au1.
  • CampaignId: The unique identifier of the campaign to delete (10-character hexadecimal string, e.g., 42694e9e57). You can obtain Campaign IDs by calling 'Search Campaigns' or 'Get Many Campaigns' workflows. WARNING: Deletion is irreversible! It is recommended to call 'Get a Campaign' to verify details before deletion.

Output:

  • Deleted (bool): Whether the campaign was successfully deleted. true=deleted successfully; false=deletion failed or campaign not found.
  • StatusCode (number): Operation status code: 200=Success (check ErrorMessage for business errors), -1=Parameter validation error, 500=System error (may retry).
  • OriginalStatusCode (number): The original HTTP status code returned by the upstream API. Use for debugging.
  • ErrorMessage (string): Detailed error message if any error occurred. Empty string if the operation succeeded.

Get Many Campaigns

Retrieves a list of MailChimp campaigns with default pagination settings.

Input Parameters:

  • DataCenter: MailChimp data center identifier (e.g., us1, us19). Find it in your MailChimp account URL: https://usXX.admin.mailchimp.com/

Options:

  • Count: Number of campaigns to return per page (1-1000). Default is 100.
  • Offset: Number of records to skip for pagination. Use 0 for first page, 100 for second page (when Count=100), etc.
  • Status: Filter campaigns by status (optional). Valid values: save, paused, schedule, sending, sent. Leave empty to get all statuses.
  • Fields: Comma-separated list of fields to include in response (optional). Example: campaigns.id,campaigns.status,campaigns.settings.subject_line. Leave empty to return all fields.

Output:

  • Campaigns (object-array): Array of campaign objects. Each campaign contains: id (string), web_id (number), type (string: regular/plaintext/absplit/rss/variate), create_time (string: ISO 8601), archive_url (string), status (string: save/paused/schedule/sending/sent), emails_sent (number), send_time (string: ISO 8601), content_type (string), recipients (object: list_id, list_name, segment_text), settings (object: subject_line, title, from_name, reply_to), tracking (object: opens, html_clicks, text_clicks), report_summary (object: opens, unique_opens, open_rate, clicks, subscriber_clicks, click_rate), delivery_status (object: enabled, can_cancel, status).
  • TotalItems (number): Total number of campaigns matching the filter criteria in your MailChimp account.
  • HasMore (bool): Indicates whether there are more campaigns to fetch. True means you need to increase Offset to get next page.
  • StatusCode (number): Operation status code: 200=Success (check ErrorMessage for business errors), -1=Parameter validation error, 500=System error (may retry).
  • ErrorMessage (string): Detailed error message if any error occurred. Empty string if the operation succeeded.
  • OriginalStatusCode (number): The original HTTP status code returned by the upstream API. Use for debugging.

Get a Campaign

Retrieves a specific MailChimp campaign by its ID.

Input Parameters:

  • DataCenter: MailChimp data center code (e.g., us1, us19). Used to construct the API endpoint URL. You can find it in the MailChimp admin panel URL: https://.admin.mailchimp.com/
  • CampaignId: The unique ID of the campaign to retrieve (10-character string). You can obtain it from 'Search Campaigns' or 'Get Many Campaigns' workflow, or from the Campaign detail page URL in MailChimp dashboard.

Output:

  • Campaign (object): The complete campaign object returned by MailChimp API. Contains fields: id (string, campaign unique identifier), web_id (number, numeric ID), type (string, campaign type like 'regular'), create_time (string, ISO 8601 format), archive_url (string, archive link), status (string, e.g. 'sent', 'draft'), long_archive_url (string), recipients (object with list_id, list_name, etc.), settings (object with subject_line, title, from_name, reply_to, etc.), tracking (object), delivery_status (object), and more. Refer to MailChimp API documentation for complete field list.
  • StatusCode (number): Operation status code: 200=Success (check ErrorMessage for business errors), -1=Parameter validation error, 500=System error (may retry).
  • ErrorMessage (string): Detailed error message if any error occurred. Empty string if the operation succeeded.
  • OriginalStatusCode (number): The original HTTP status code returned by the upstream API. Use for debugging.

Send a Campaign

Sends the specified MailChimp campaign.

Input Parameters:

  • DataCenter: Mailchimp data center code (e.g., us1, us19, us20). Specifies the API request region.

How to obtain:

  1. Log in to your Mailchimp account
  2. Click profile avatar → Account → Settings → Extras → API Keys
  3. Check the code after 'Your API Key ends with' (e.g., us1)

Example values: us1, us19, eu1

  • CampaignId: The unique identifier of the campaign to send.

How to obtain:

  • Use the List Campaigns action to get all campaign IDs
  • Use the Get Campaign action to query a specific campaign

Prerequisites:

  • Campaign must be in 'ready' status to send. Non-ready campaigns will return an error.

Example value: 42694e9e57

Output:

  • Sent (bool): Whether the campaign was sent successfully.
  • StatusCode (number): Operation status code: 200=Success (check ErrorMessage for business errors), -1=Parameter validation error, 500=System error (may retry).
  • ErrorMessage (string): Detailed error message if any error occurred. Empty string if the operation succeeded.
  • OriginalStatusCode (number): The original HTTP status code returned by the upstream API. Use for debugging.

Replicate a Campaign

Replicates a specific MailChimp campaign by its ID.

Input Parameters:

  • DataCenter: Mailchimp data center code that specifies the API server region. Common values: us1, us19 (United States); eu1 (Europe). If unsure, log in to Mailchimp dashboard and check the API Keys page URL - the 'usX' part in 'https://usX.admin.mailchimp.com' is your data center code.
  • CampaignId: The unique ID of the campaign to replicate. You can obtain this ID via 'Get Campaigns' or 'Search Campaigns' workflows. Format: 10-character alphanumeric string (e.g., 'a1b2c3d4e5').

Output:

  • Campaign (object): The newly replicated campaign object containing fields: id (string, unique campaign ID), web_id (number), type (string: 'regular'|'plaintext'|'absplit'|'rss'|'variate'), create_time (string, ISO 8601 timestamp), archive_url (string), status (string: 'save'|'paused'|'schedule'|'sending'|'sent'), emails_sent (number), send_time (string, ISO 8601 timestamp), content_type (string), recipients (object with list_id, segment_opts), settings (object with subject_line, preview_text, title, from_name, reply_to), tracking (object with opens, html_clicks, text_clicks), delivery_status (object with enabled, can_cancel, status).
  • StatusCode (number): Operation status code: 200=Success (check ErrorMessage for business errors), -1=Parameter validation error, 500=System error (may retry).
  • ErrorMessage (string): Detailed error message if any error occurred. Empty string if the operation succeeded.
  • OriginalStatusCode (number): The original HTTP status code returned by the upstream API. Use for debugging.

Resend a Campaign

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

Input Parameters:

  • DataCenter: MailChimp data center identifier (e.g., us1, us2, us19). Used to construct API request URL.

How to get:

  1. Log in to MailChimp account
  2. Check browser address bar, e.g., https://us19.admin.mailchimp.com/
  3. The data center identifier is 'us19'

Common values: us1-us20 (United States), au1 (Australia)

  • CampaignId: The ID of the campaign to create a resend version for.

How to get:

  • Method 1: Call 'Get Campaign' or 'List Campaigns' API
  • Method 2: Log in to MailChimp, go to Campaigns page, click campaign name, the last segment of URL is the Campaign ID

Example: If URL is https://us19.admin.mailchimp.com/campaigns/edit?id=42abc123, then ID is '42abc123'

Output:

  • IsResent (bool): Indicates whether the resend version was successfully created:
  • true: Resend version created (status is Draft, not sent yet)
  • false: Creation failed, see ErrorMessage for details

Next steps:

  • To send immediately: Call 'Send Campaign' API
  • To modify settings: Call 'Update Campaign' API
  • To view details: Call 'Get Campaign' API
  • StatusCode (number): Operation status code: 200=Success (check ErrorMessage for business errors), -1=Parameter validation error, 500=System error (may retry).
  • ErrorMessage (string): Detailed error message if any error occurred. Empty string if the operation succeeded.
  • OriginalStatusCode (number): The original HTTP status code returned by the upstream API. Use for debugging.

Get Many List Groups

Retrieves a list of groups for the specified MailChimp list.

Input Parameters:

  • DataCenter: Server region code (e.g., us1, us19, eu1). Can be found in your Mailchimp account settings under 'API Keys'. Typically formatted as 'us' or 'eu' followed by a number.
  • ListId: The unique ID of the Mailchimp list (audience). Format: 10-character alphanumeric string (e.g., 'a1b2c3d4e5'). Can be obtained via the 'Get Many Lists' action.

Options:

  • Count: Number of interest categories to return per request. Range: 1-1000. Default: 50. Recommended: ≤100 for better performance and token efficiency.
  • Offset: Number of records to skip (for pagination). Default: 0. Example: Use offset=50 with count=50 to get the second page of results.

Output:

  • Categories (object-array): A list of interest category objects returned by Mailchimp. Each object contains: id (string, unique identifier), title (string, display name), type (string, one of: checkboxes/radio/dropdown/hidden), display_order (number), list_id (string), web_id (number).
  • TotalItems (number): The total number of interest categories available in the list (across all pages).
  • Pagination (object): Pagination metadata. Contains: Count (number, requested items per page), Offset (number, starting position), HasMore (boolean, whether more items exist after current page).
  • StatusCode (number): Operation status code: 200=Success (check ErrorMessage for business errors), -1=Parameter validation error, 500=System error (may retry).
  • ErrorMessage (string): Detailed error message if any error occurred. Empty string if the operation succeeded.
  • OriginalStatusCode (number): The original HTTP status code returned by the upstream API. Use for debugging.

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.

Was This Page Helpful?
Discussion

Leave a Reply.

Your email address will not be published. Required fields are marked*

loading...
No Results