Skip to main content

Mailchimp

Mailchimp is a powerful marketing automation platform that allows you to manage and communicate with your clients, customers, and other interested parties. It provides tools to create and manage mailing lists, newsletters, automated campaigns, and more.

Search members​

Search for list members in Mailchimp using a query. This can be restricted to a specific list or search across all lists in an account.

Fields​

  • Datacenter: The datacenter specific to your Mailchimp account. You can find this in the URL of your Mailchimp dashboard, e.g., 'us1', 'us2'. This is required to correctly route your API requests.

  • Search Query: The search query used to filter results. This should be a valid email, or a string representing a contact's first or last name. Ensure the query is correctly formatted to return accurate results.

  • List ID: The unique ID for the list you want to search. You can find this in your Mailchimp account under the list settings. This field is optional; if not provided, the search will be conducted across all lists.

Output​

The output will be a list of members that match the search query, including their details such as email address, status, and list ID.

Get all lists​

Retrieve information about all lists in the Mailchimp account.

Fields​

  • Datacenter: The datacenter specific to your Mailchimp account. It is usually the subdomain in your Mailchimp URL, such as 'us1', 'us2', etc. This is required for API access.

  • Number of Records: The number of records to return. Default is 10, and the maximum is 1000. Adjust this to control the volume of data returned.

Output​

The output will include details of all lists in your Mailchimp account, such as list ID, name, and subscriber count.

Add a new member to a list​

Add a new member to a specified list in Mailchimp.

Fields​

  • Datacenter: The datacenter specific to your Mailchimp account. It is usually the last part of your API key after the dash. For example, if your API key is 'abcd1234-us1', then 'us1' is your datacenter.

  • List ID: The unique ID for the list you want to add a member to. You can find this ID in your Mailchimp account under the list settings.

  • Email Address: The email address of the subscriber you want to add to the list. Ensure the email is valid to avoid errors.

  • Tags: A list of tags to associate with the member. Tags help categorize and organize your subscribers. Provide a valid JSON array of tags.

Output​

The output will confirm the addition of the new member to the specified list, including their email address and assigned tags.

Add or Remove Member Tags​

Add or remove tags from a list member in Mailchimp.

Fields​

  • Datacenter: The datacenter specific to your Mailchimp account. It is usually a part of your API key, e.g., 'us1', 'us2'.

  • List ID: The unique ID for the list. You can find this in your Mailchimp account under the list settings.

  • Subscriber Email: The email address or MD5 hash of the lowercase version of the list member's email address.

  • Tag Name: The name of the tag you want to add or remove from the list member.

  • Tag Status: The status for the tag on the member. Use 'active' to add a tag or 'inactive' to remove it.

Output​

The output will confirm the addition or removal of the specified tag for the list member.

Unsubscribe member from a list​

Update the status of a specific list member to unsubscribed in Mailchimp.

Fields​

  • Datacenter: The datacenter specific to your Mailchimp account. You can find this in the URL of your Mailchimp dashboard, e.g., 'us1', 'us2'.

  • List ID: The unique ID for the list. You can find this in your Mailchimp account under the list settings.

  • Subscriber Email: The MD5 hash of the lowercase version of the list member's email address. Alternatively, you can use the list member's email address or contact_id.

Output​

The output will confirm the member's status has been updated to unsubscribed.

Update List Member Status​

Update the status of a specific list member in a Mailchimp list.

Fields​

  • Datacenter: The datacenter specific to your Mailchimp account. It is the subdomain in your Mailchimp API URL, such as 'us1', 'us2', etc.

  • List ID: The unique ID for the Mailchimp list. You can find this in your Mailchimp account under the list settings.

  • Subscriber Email: The MD5 hash of the lowercase version of the list member's email address. Alternatively, you can use the list member's email address or contact_id.

  • Skip Merge Validation: Set to true to accept member data without merge field values, even if they are usually required. Defaults to false.

  • Status: The subscriber's current status. Possible values are 'subscribed', 'unsubscribed', 'cleaned', or 'pending'.

Output​

The output will confirm the updated status of the list member, reflecting the changes made.