Skip to content

Mailchimp Connection ​

The Mailchimp Connection authorizes supported Mailchimp Marketing operations for audiences, members, tags, campaigns, and reports.

It exposes an API Request command for supported client and server contexts and named methods through the $io.mailChimp Server API.

Capabilities ​

CapabilityAvailability
Connection service identifiermailchimp
Page Flow commandAPI Request
Cloud Flow commandAPI Request
Connection methodsSupported
Server API$io.mailChimp
Connection-backed SDK objectNot documented
AI Agent Connection supportSupported

Authentication Modes ​

The Profile supports direct credential and OAuth-based configuration:

  • Custom Access Token, using the Mailchimp API key field shown by the Profile.
  • OAuth2, using the ioLoop-provided authorization flow.
  • Custom OAuth2, using your own client ID, client secret, and optional scopes.

A Mailchimp API key commonly includes a data-center suffix. Enter the complete value supplied by Mailchimp.

The Connection has no additional service settings beyond its name and selected Profile.

API Request Command ​

The API Request command accepts:

  • A Mailchimp API path or supported full Mailchimp API URL.
  • An HTTP method.
  • Request data for methods with a body.
  • Query parameters.
  • Supported optional request configuration.

The command supports Page Flow and Cloud Flow. Page Flow calls still execute on the server using the Profile.

Do not accept an arbitrary API URL or method directly from an untrusted user. Use named Cloud Flow logic to constrain audiences, campaigns, members, and permitted changes.

Server Methods ​

The Mailchimp Server API includes supported methods for:

  • Listing and retrieving audiences.
  • Listing, retrieving, creating, or updating audience members.
  • Searching for members.
  • Adding and removing member tags.
  • Listing and retrieving campaigns.
  • Retrieving report opens and clicks.
  • Handling offset-based pagination helpers.
  • Executing a supported authenticated API request.

Use $io.mailChimp for exact signatures. The namespace uses a capital C in mailChimp.

Testing ​

Use a test audience and controlled addresses. Verify subscriber status, merge fields, tags, campaign identifiers, pagination, and provider error handling.

Be careful with operations that can subscribe contacts, change marketing preferences, or affect real campaigns. Provider consent and compliance requirements remain the responsibility of the Project and account owner.