> For the complete documentation index, see [llms.txt](https://docs.balkan.id/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.balkan.id/getting-started/setting-up-your-tenant/application-integrations/direct-application-integrations/mailchimp-integration-setup.md).

# Mailchimp Integration Setup

### Getting Started

Use this guide to connect Mailchimp to your BalkanID tenant. You will need an API key from Mailchimp and access to the Integrations section in BalkanID.

{% hint style="info" %}
The Mailchimp Marketing API reports only the account user who owns the API key. Mailchimp does not provide an endpoint that lists the other users on an account, so this integration brings in that single user and their account role.
{% endhint %}

#### Requirements:

Before you begin, collect the following values from Mailchimp:

* **API key**
* **Datacenter**

### Configure Mailchimp within your BalkanID tenant

1. To create the API key, sign in to Mailchimp, click your profile icon and select **Profile**.
2. Click the **Extras** dropdown and choose **API keys**.
3. In the Your API Keys section, click **Create A Key**, give the key a descriptive name, then click **Generate Key**. Copy the key before you close the dialog — Mailchimp displays it in full only once.
4. Read the Datacenter from the end of the key. In a key ending `-us19`, the Datacenter is `us19`.
5. In BalkanID, go to **Integrations** and click **Add integration**.

<div data-with-frame="true"><figure><img src="https://2975852473-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbVGYwk8aSk5yI1GDPEW9%2Fuploads%2FQDQ2FHtiXqTz23JyIp97%2Fmailchimp-add-integration.png?alt=media" alt="The BalkanID Integrations page with the Add integration button in the top right"><figcaption><p>Add integration</p></figcaption></figure></div>

6. Search for Mailchimp, select it, and click **Next**.

<div data-with-frame="true"><figure><img src="https://2975852473-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbVGYwk8aSk5yI1GDPEW9%2Fuploads%2F07EOtiZZ7LjbGNnu74wK%2FScreenshot%202026-09-02%20at%204.01.58%E2%80%AFAM.png?alt=media&#x26;token=e9d58228-0fd5-4d5b-b48d-92db8ea2e21c" alt="The Connect a new application step with Mailchimp searched and selected"><figcaption><p>Connect a new application</p></figcaption></figure></div>

7. Under **Select Extraction Type**, choose **Direct Configuration** and enter the **API key** and **Datacenter** you collected above.

<div data-with-frame="true"><figure><img src="https://2975852473-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbVGYwk8aSk5yI1GDPEW9%2Fuploads%2FwxZ7wnFp5ZqUzDuzcG6d%2Fmailchimp-direct-configuration.png?alt=media" alt="Direct Configuration selected, showing the API key and Datacenter fields"><figcaption><p>Direct Configuration</p></figcaption></figure></div>

8. Click Next to move onto Optional Configuration.
9. Fill **Optional Configuration**, if required.

<div data-with-frame="true"><figure><img src="https://2975852473-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbVGYwk8aSk5yI1GDPEW9%2Fuploads%2FZbipc8nl8LTFl5YsVIaj%2Foptional-configuration.png?alt=media" alt="The Optional Configuration step showing Reviewer Settings and fulfillment options"><figcaption><p>Optional Configuration</p></figcaption></figure></div>

10. Once you have filled in the information, click **Save**. Your integration is now configured and you will see the status of the integration displayed alongside other integrations on the Integrations page. When data is available, the integration Status column will read **Connected** and the integration Message will read **Data available**.

### Integration Scopes

Mailchimp API keys are not scoped individually. A key inherits the permissions of the Mailchimp user who created it, so generate the key from a user who holds at least Manager permissions.

| Read Only Scopes                                                                     | Lifecycle Management Scopes |
| ------------------------------------------------------------------------------------ | --------------------------- |
| **Account (Read)** — reads the account and the role of the user who owns the API key | N/A                         |

{% hint style="info" %}
Mailchimp removes any API keys generated by a user when that user's access to the account is revoked. If the key stops working, confirm that the user who created it still has access, then generate a replacement key.
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.balkan.id/getting-started/setting-up-your-tenant/application-integrations/direct-application-integrations/mailchimp-integration-setup.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.