Mailchimp Installation Instructions

Log in to your Mailchimp account.

On the Mailchimp Home page, click your account icon.

Select Profile from the drop-down menu

Click Extras, and then select API keys.

Scroll down to the Your API keys section. You cannot view or copy any existing keys

Click Create A Key. Mailchimp creates the key.

Click Copy to Clipboard. Remember to save the API key for later use.

Click Done. Your new key information is displayed on the Your API keys list.

Go to Subscriptions Management > Subscriptions and click Search Certified Integration Marketplace and Subscribe.
​

Click the Mailchimp Integration title.
​

​On the Subscription Detail page, click the Subscribe button.

Enter the Name of the subscription and select a Version. It can be set to any relevant and unique subscription name within the company where this subscription is created.

Select Create Default Mappings (recommended).
If you don’t want to create default mappings and want to create all mappings by yourself, then uncheck this box.
​

Provide the API URL endpoint for your Mailchimp instance.

Enter the API Key you generated in Mailchimp.

Enter the Variant External ID Delimiter. This setting specifies which character separates the product ID and variant ID in external identifiers for product variants. The delimiter keeps both values distinct while forming a single, readable key. For example, using the pipe character (|) as the delimiter with product ID 12345 and variant ID 67890 creates the external ID: 12345|67890. The system requires this delimiter to properly construct variant external IDs.

Enter the Special Character Replacement. This setting defines which safe character (such as _ or -) replaces reserved or unsafe symbols in product and variant IDs before sending them to the API.
Reserved characters like /, ?, or # can break URLs, API calls, or database lookups. When the system encounters these symbols in an ID, it substitutes them with your configured replacement character. If no replacement character is configured, updates will fail with an error.

Set Customer Store ID Custom Field Name to true or false. When set to true, the integration uses the store ID included in each incoming order. This store ID is then written to related entities such as customers, products, and variants. This ensures all data stays linked to the correct store in downstream systems like Mailchimp. When set to false, the integration ignores any store ID in the order payload and routes all data to a single, fixed store.

Enter the API Throttle Limit. This setting prevents any single integration or user from overwhelming the system with too many requests. It protects system performance by controlling the number of API requests that can run simultaneously, ensuring fair usage.

Enter the API Throttle Seconds. This defines the time window during which the API Throttle Limit is measured. If an integration makes too many requests within this time window, additional requests are rejected until the window resets.

Enter the number of Concurrent Connections. This specifies the maximum number of simultaneous API connections that the subscription can process for a user or integration. If this limit is exceeded, new requests are queued or rejected until a currently active connection finishes.

Enter the number of Concurrent Batch Executions. This specifies the maximum number of simultaneous batch executions that can process for an integration at one time. If this limit is exceeded, new requests are queued or rejected until a currently active connection finishes.

Click Apply to save the settings.

Initiate a sample data pull. (To iPaaS.com).

Initiate a sample data push. (From iPaaS.com).

Run an end-to-end business process.

Validate key features like field mappings, workflow triggers, and logging.

Review integration logs in iPaaS.com.