Mailchimp connector

1. Install the SDK

   Node.js

   npm install @scalekit-sdk/node

   Python

   pip install scalekit

   Full SDK reference: Node.js | Python

2. Set your credentials

   Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.

   .env

   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>

3. Set up the connector

   Register your Mailchimp credentials with Scalekit so it handles the token lifecycle. You do this once per environment.

   Dashboard setup steps

   Register your Mailchimp account with Scalekit so Scalekit handles the OAuth flow and token refresh automatically. The connection name you create is used to identify and invoke the connection in your code.

   1. Set up auth redirects

      • In Scalekit dashboard, go to AgentKit > Connections > Create Connection. Find Mailchimp and click Create. Copy the redirect URI — it looks like https://<SCALEKIT_ENV_URL>/sso/v1/oauth/<CONNECTION_ID>/callback.

      

      • Log in to your Mailchimp account and go to Account & Billing > Extras > API keys > OAuth apps.

      

      • Click Register An App, fill in the app details, and paste the redirect URI from Scalekit into the redirect URI field.

      

   2. Get client credentials

      • In your Mailchimp OAuth app, copy the Client ID and Client Secret.

   3. Add credentials in Scalekit

      • In Scalekit dashboard, open the Mailchimp connection you created and enter:
        • Client ID
        • Client Secret

      

      No scopes required

      Mailchimp OAuth does not use scopes — all authenticated users get access to all API endpoints their plan supports.

      • Click Save.

   4. Connect a user account

      • Click the Connected Accounts tab, then Add Account.
      • Enter your user’s ID and click Create Account — you’ll be redirected to Mailchimp to authorize access.

      

4. Authorize and make your first call

   Node.js

   quickstart.ts

   import { ScalekitClient } from '@scalekit-sdk/node'
   import 'dotenv/config'
   
   const scalekit = new ScalekitClient(
     process.env.SCALEKIT_ENV_URL,
     process.env.SCALEKIT_CLIENT_ID,
     process.env.SCALEKIT_CLIENT_SECRET,
   )
   const actions = scalekit.actions
   
   const connector = 'mailchimp'
   const identifier = 'user_123'
   
   // Generate an authorization link for the user
   const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
   console.log('Authorize Mailchimp:', link)
   process.stdout.write('Press Enter after authorizing...')
   await new Promise(r => process.stdin.once('data', r))
   
   // Make your first call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'mailchimp_account_info',
     toolInput: {},
   })
   console.log(result)

   Python

   quickstart.py

   import os
   from scalekit.client import ScalekitClient
   from dotenv import load_dotenv
   load_dotenv()
   
   scalekit_client = ScalekitClient(
       env_url=os.getenv("SCALEKIT_ENV_URL"),
       client_id=os.getenv("SCALEKIT_CLIENT_ID"),
       client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
   )
   actions = scalekit_client.actions
   
   connection_name = "mailchimp"
   identifier = "user_123"
   
   # Generate an authorization link for the user
   link_response = actions.get_authorization_link(
       connection_name=connection_name,
       identifier=identifier,
   )
   print("Authorize Mailchimp:", link_response.link)
   input("Press Enter after authorizing...")
   
   # Make your first call
   result = actions.execute_tool(
       tool_input={},
       tool_name="mailchimp_account_info",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)

What you can do

Connect this agent connector to let your agent:

• List templates, segments, segment members — Return a list of templates in the Mailchimp account, including user-created and Mailchimp base templates
• Update template, segment, campaign — Update a user-defined template’s name or HTML content in Mailchimp
• Get template, segment, report — Retrieve information about a specific template in the Mailchimp account
• Delete template, segment, campaign — Permanently delete a user-defined template from Mailchimp
• Create template, segment, campaign — Create a new user-defined HTML template in Mailchimp
• Unsubscribes report — Return a list of members who unsubscribed from a specific Mailchimp campaign

Common workflows

Proxy API call

Node.js

const result = await actions.request({
  connectionName: 'mailchimp',
  identifier: 'user_123',
  path: '/ping',
  method: 'GET',
});
console.log(result);

Python

result = actions.request(
    connection_name='mailchimp',
    identifier='user_123',
    path="/ping",
    method="GET"
)
print(result)

Add a subscriber

Node.js

const member = await actions.executeTool({
  connector: 'mailchimp',
  identifier: 'user_123',
  toolName: 'mailchimp_list_member_add',
  toolInput: {
    list_id: 'abc123def',
    email_address: 'jane.smith@example.com',
    status: 'subscribed',
    first_name: 'Jane',
    last_name: 'Smith',
  },
});
console.log('Added member:', member.id);

Python

member = actions.execute_tool(
    connection_name='mailchimp',
    identifier='user_123',
    tool_name="mailchimp_list_member_add",
    tool_input={
        "list_id": "abc123def",
        "email_address": "jane.smith@example.com",
        "status": "subscribed",
        "first_name": "Jane",
        "last_name": "Smith",
    },
)
print("Added member:", member["id"])

Create and send a campaign

Node.js

const campaign = await actions.executeTool({
  connector: 'mailchimp',
  identifier: 'user_123',
  toolName: 'mailchimp_campaign_create',
  toolInput: {
    type: 'regular',
    list_id: 'abc123def',
    subject_line: 'Your April newsletter',
    from_name: 'Acme Corp',
    reply_to: 'hello@acme.com',
  },
});

await actions.executeTool({
  connector: 'mailchimp',
  identifier: 'user_123',
  toolName: 'mailchimp_campaign_content_set',
  toolInput: {
    campaign_id: campaign.id,
    html: '<h1>Hello!</h1><p>Here is your monthly update.</p>',
  },
});

await actions.executeTool({
  connector: 'mailchimp',
  identifier: 'user_123',
  toolName: 'mailchimp_campaign_send',
  toolInput: { campaign_id: campaign.id },
});
console.log('Campaign sent:', campaign.id);

Python

campaign = actions.execute_tool(
    connection_name='mailchimp',
    identifier='user_123',
    tool_name="mailchimp_campaign_create",
    tool_input={
        "type": "regular",
        "list_id": "abc123def",
        "subject_line": "Your April newsletter",
        "from_name": "Acme Corp",
        "reply_to": "hello@acme.com",
    },
)

actions.execute_tool(
    connection_name='mailchimp',
    identifier='user_123',
    tool_name="mailchimp_campaign_content_set",
    tool_input={
        "campaign_id": campaign["id"],
        "html": "<h1>Hello!</h1><p>Here is your monthly update.</p>",
    },
)

actions.execute_tool(
    connection_name='mailchimp',
    identifier='user_123',
    tool_name="mailchimp_campaign_send",
    tool_input={"campaign_id": campaign["id"]},
)
print("Campaign sent:", campaign["id"])

Get campaign report

Node.js

const report = await actions.executeTool({
  connector: 'mailchimp',
  identifier: 'user_123',
  toolName: 'mailchimp_report_get',
  toolInput: { campaign_id: 'abc123' },
});
console.log(`Opens: ${report.opens.open_rate}, Clicks: ${report.clicks.click_rate}`);

Python

report = actions.execute_tool(
    connection_name='mailchimp',
    identifier='user_123',
    tool_name="mailchimp_report_get",
    tool_input={"campaign_id": "abc123"},
)
print(f"Opens: {report['opens']['open_rate']}, Clicks: {report['clicks']['click_rate']}")

Tool list

Use the exact tool names from the Tool list below when you call execute_tool. If you’re not sure which name to use, list the tools available for the current user first.

mailchimp_account_info#Retrieve details about the connected Mailchimp account, including username, contact info, and plan details.1 param▾

Retrieve details about the connected Mailchimp account, including username, contact info, and plan details.

NameTypeRequiredDescription

fieldsstringoptionalComma-separated list of fields to return.

mailchimp_automation_get#Retrieve details about a specific classic automation in Mailchimp.1 param▾

Retrieve details about a specific classic automation in Mailchimp.

NameTypeRequiredDescription

workflow_idstringrequiredThe ID of the automation. Get it from `mailchimp_automations_list`.

mailchimp_automation_pause#Pause all emails in a Mailchimp classic automation.1 param▾

Pause all emails in a Mailchimp classic automation.

NameTypeRequiredDescription

workflow_idstringrequiredThe ID of the automation. Get it from `mailchimp_automations_list`.

mailchimp_automation_start#Start all emails in a Mailchimp classic automation.1 param▾

Start all emails in a Mailchimp classic automation.

NameTypeRequiredDescription

workflow_idstringrequiredThe ID of the automation. Get it from `mailchimp_automations_list`.

mailchimp_automations_list#Return a summary of all classic automations (Email Series) in the Mailchimp account.4 params▾

Return a summary of all classic automations (Email Series) in the Mailchimp account.

NameTypeRequiredDescription

countintegeroptionalNumber of records per page.

fieldsstringoptionalComma-separated fields to return.

offsetintegeroptionalNumber of records to skip.

statusstringoptionalFilter by automation status: `save`, `paused`, `sending`.

mailchimp_batch_status_get#Check the status of a Mailchimp batch operation. Use this to poll the result of a previously submitted batch request.1 param▾

Check the status of a Mailchimp batch operation. Use this to poll the result of a previously submitted batch request.

NameTypeRequiredDescription

batch_idstringrequiredThe ID of the batch operation. Returned when a batch is created via the Mailchimp API.

mailchimp_campaign_content_get#Retrieve the content (HTML, plain text, or template) of a Mailchimp campaign.2 params▾

Retrieve the content (HTML, plain text, or template) of a Mailchimp campaign.

NameTypeRequiredDescription

campaign_idstringrequiredThe ID of the campaign. Get it from `mailchimp_campaigns_list`.

fieldsstringoptionalComma-separated fields to return.

mailchimp_campaign_content_set#Set the HTML or plain text content of a Mailchimp campaign.4 params▾

Set the HTML or plain text content of a Mailchimp campaign.

NameTypeRequiredDescription

campaign_idstringrequiredThe ID of the campaign. Get it from `mailchimp_campaigns_list`.

htmlstringoptionalFull HTML content for the campaign.

plain_textstringoptionalPlain text version of the campaign content.

template_idstringoptionalID of a saved Mailchimp template to use. Get it from `mailchimp_templates_list`.

mailchimp_campaign_create#Create a new Mailchimp campaign (regular, plaintext, A/B split, RSS, or variate).8 params▾

Create a new Mailchimp campaign (regular, plaintext, A/B split, RSS, or variate).

NameTypeRequiredDescription

list_idstringrequiredThe ID of the audience to send to. Get it from `mailchimp_lists_list`.

typestringrequiredCampaign type: `regular`, `plaintext`, `absplit`, `rss`, `variate`.

from_namestringoptionalThe 'from' name for the campaign.

preview_textstringoptionalPreview text displayed in the inbox.

reply_tostringoptionalThe reply-to email address.

segment_idstringoptionalID of a segment to send to (optional). Get it from `mailchimp_segments_list`.

subject_linestringoptionalThe subject line for the campaign.

titlestringoptionalThe internal title for this campaign (not shown to subscribers).

mailchimp_campaign_delete#Remove a campaign from a Mailchimp account. Only campaigns in draft or removed status can be deleted.1 param▾

Remove a campaign from a Mailchimp account. Only campaigns in draft or removed status can be deleted.

NameTypeRequiredDescription

campaign_idstringrequiredThe ID of the campaign to delete. Get it from `mailchimp_campaigns_list`.

mailchimp_campaign_get#Retrieve details about a specific Mailchimp campaign.2 params▾

Retrieve details about a specific Mailchimp campaign.

NameTypeRequiredDescription

campaign_idstringrequiredThe ID of the campaign. Get it from `mailchimp_campaigns_list`.

fieldsstringoptionalComma-separated fields to return.

mailchimp_campaign_schedule#Schedule a Mailchimp campaign to be sent at a specific time.2 params▾

Schedule a Mailchimp campaign to be sent at a specific time.

NameTypeRequiredDescription

campaign_idstringrequiredThe ID of the campaign to schedule. Get it from `mailchimp_campaigns_list`.

schedule_timestringrequiredUTC datetime to send the campaign in ISO 8601 format (e.g., `2026-05-01T14:00:00+00:00`).

mailchimp_campaign_send#Send a Mailchimp campaign immediately. The campaign must be in `save` status with valid content and recipients.1 param▾

Send a Mailchimp campaign immediately. The campaign must be in `save` status with valid content and recipients.

NameTypeRequiredDescription

campaign_idstringrequiredThe ID of the campaign to send. Get it from `mailchimp_campaigns_list`.

mailchimp_campaign_test#Send a test email for a Mailchimp campaign to one or more email addresses.3 params▾

Send a test email for a Mailchimp campaign to one or more email addresses.

NameTypeRequiredDescription

campaign_idstringrequiredThe ID of the campaign. Get it from `mailchimp_campaigns_list`.

test_emailsstringrequiredJSON array of email addresses to send the test to.

send_typestringoptionalEmail format for the test: `html` or `plaintext`.

mailchimp_campaign_unschedule#Cancel a scheduled Mailchimp campaign and return it to draft status.1 param▾

Cancel a scheduled Mailchimp campaign and return it to draft status.

NameTypeRequiredDescription

campaign_idstringrequiredThe ID of the scheduled campaign. Get it from `mailchimp_campaigns_list`.

mailchimp_campaign_update#Update the settings of a Mailchimp campaign that has not yet been sent.7 params▾

Update the settings of a Mailchimp campaign that has not yet been sent.

NameTypeRequiredDescription

campaign_idstringrequiredThe ID of the campaign. Get it from `mailchimp_campaigns_list`.

from_namestringoptionalUpdated 'from' name.

list_idstringoptionalUpdated audience ID.

preview_textstringoptionalNew preview text.

reply_tostringoptionalUpdated reply-to email address.

subject_linestringoptionalNew subject line.

titlestringoptionalNew internal campaign title.

mailchimp_campaigns_list#Return a list of all campaigns in the Mailchimp account, with optional filters.8 params▾

Return a list of all campaigns in the Mailchimp account, with optional filters.

NameTypeRequiredDescription

countintegeroptionalNumber of records per page.

fieldsstringoptionalComma-separated fields to return.

list_idstringoptionalFilter by audience ID.

offsetintegeroptionalNumber of records to skip.

sort_dirstringoptionalSort direction: `ASC` or `DESC`.

sort_fieldstringoptionalSort field: `create_time` or `send_time`.

statusstringoptionalFilter by status: `save`, `paused`, `schedule`, `sending`, `sent`.

typestringoptionalFilter by campaign type: `regular`, `plaintext`, `absplit`, `rss`, `variate`.

mailchimp_list_create#Create a new Mailchimp audience (list). Requires a contact address and campaign defaults.13 params▾

Create a new Mailchimp audience (list). Requires a contact address and campaign defaults.

NameTypeRequiredDescription

contact_addressstringrequiredThe street address for the contact address.

contact_citystringrequiredThe city for the contact address.

contact_companystringrequiredThe company name for the contact address (required by Mailchimp).

contact_countrystringrequiredThe two-letter ISO country code for the contact address (e.g. `US`).

contact_statestringrequiredThe state or province for the contact address.

contact_zipstringrequiredThe postal/ZIP code for the contact address.

email_type_optionbooleanrequiredWhether to allow subscribers to choose email format (HTML or plain text).

from_emailstringrequiredThe default sender email address for campaigns.

from_namestringrequiredThe default display name for the campaign sender.

namestringrequiredThe name of the audience.

permission_reminderstringrequiredA reminder for subscribers about why they were added.

languagestringoptionalThe default language for the audience (e.g. `en`, `fr`).

subjectstringoptionalThe default subject line for campaigns.

mailchimp_list_delete#Permanently delete a Mailchimp audience and all its members.1 param▾

Permanently delete a Mailchimp audience and all its members.

NameTypeRequiredDescription

list_idstringrequiredThe ID of the audience to delete. Get it from `mailchimp_lists_list`.

mailchimp_list_get#Retrieve information about a specific Mailchimp audience (list) by its ID.2 params▾

Retrieve information about a specific Mailchimp audience (list) by its ID.

NameTypeRequiredDescription

list_idstringrequiredThe ID of the audience. Get it from `mailchimp_lists_list`.

fieldsstringoptionalComma-separated fields to return.

mailchimp_list_member_add#Add a new member to a Mailchimp audience.6 params▾

Add a new member to a Mailchimp audience.

NameTypeRequiredDescription

email_addressstringrequiredThe member's email address.

list_idstringrequiredThe ID of the audience. Get it from `mailchimp_lists_list`.

statusstringrequiredSubscription status: `subscribed`, `unsubscribed`, `cleaned`, `pending`.

first_namestringoptionalMember's first name (stored in FNAME merge field).

last_namestringoptionalMember's last name (stored in LNAME merge field).

tagsstringoptionalJSON array of tag names to apply to the member.

mailchimp_list_member_archive#Archive a member in a Mailchimp audience (soft delete). The member's data is preserved but they will not receive campaigns. The `subscriber_hash` is the MD5 hash of the lowercase email.2 params▾

Archive a member in a Mailchimp audience (soft delete). The member's data is preserved but they will not receive campaigns. The `subscriber_hash` is the MD5 hash of the lowercase email.

NameTypeRequiredDescription

list_idstringrequiredThe ID of the audience. Get it from `mailchimp_lists_list`.

subscriber_hashstringrequiredMD5 hash of the member's lowercase email address.

mailchimp_list_member_delete_permanent#Permanently delete a member from a Mailchimp audience. This removes all of their data and cannot be undone. Use `mailchimp_list_member_archive` for a reversible soft delete.2 params▾

Permanently delete a member from a Mailchimp audience. This removes all of their data and cannot be undone. Use `mailchimp_list_member_archive` for a reversible soft delete.

NameTypeRequiredDescription

list_idstringrequiredThe ID of the audience. Get it from `mailchimp_lists_list`.

subscriber_hashstringrequiredMD5 hash of the member's lowercase email address.

mailchimp_list_member_get#Retrieve information about a specific member in a Mailchimp audience. The `subscriber_hash` is the MD5 hash of the member's lowercase email address.3 params▾

Retrieve information about a specific member in a Mailchimp audience. The `subscriber_hash` is the MD5 hash of the member's lowercase email address.

NameTypeRequiredDescription

list_idstringrequiredThe ID of the audience. Get it from `mailchimp_lists_list`.

subscriber_hashstringrequiredMD5 hash of the member's lowercase email address.

fieldsstringoptionalComma-separated fields to return.

mailchimp_list_member_tags_get#Retrieve the tags assigned to a specific member in a Mailchimp audience.2 params▾

Retrieve the tags assigned to a specific member in a Mailchimp audience.

NameTypeRequiredDescription

list_idstringrequiredThe ID of the audience. Get it from `mailchimp_lists_list`.

subscriber_hashstringrequiredMD5 hash of the member's lowercase email address.

mailchimp_list_member_tags_update#Add or remove tags for a specific member in a Mailchimp audience. Provide a JSON array of tag objects with `name` and `status` (`active` to add, `inactive` to remove).3 params▾

Add or remove tags for a specific member in a Mailchimp audience. Provide a JSON array of tag objects with `name` and `status` (`active` to add, `inactive` to remove).

NameTypeRequiredDescription

list_idstringrequiredThe ID of the audience. Get it from `mailchimp_lists_list`.

subscriber_hashstringrequiredMD5 hash of the member's lowercase email address.

tagsstringrequiredJSON array of tag objects. Each has `name` (string) and `status` (`active` to add, `inactive` to remove).

mailchimp_list_member_update#Update an existing member's data in a Mailchimp audience. The `subscriber_hash` is the MD5 hash of the member's lowercase email address.6 params▾

Update an existing member's data in a Mailchimp audience. The `subscriber_hash` is the MD5 hash of the member's lowercase email address.

NameTypeRequiredDescription

list_idstringrequiredThe ID of the audience. Get it from `mailchimp_lists_list`.

subscriber_hashstringrequiredMD5 hash of the member's lowercase email address.

email_addressstringoptionalUpdated email address.

first_namestringoptionalUpdated first name (FNAME merge field).

last_namestringoptionalUpdated last name (LNAME merge field).

statusstringoptionalNew subscription status: `subscribed`, `unsubscribed`, `cleaned`, `pending`.

mailchimp_list_member_upsert#Add a new member or update an existing member in a Mailchimp audience (idempotent). The `subscriber_hash` is the MD5 hash of the lowercase email address.7 params▾

Add a new member or update an existing member in a Mailchimp audience (idempotent). The `subscriber_hash` is the MD5 hash of the lowercase email address.

NameTypeRequiredDescription

email_addressstringrequiredThe member's email address.

list_idstringrequiredThe ID of the audience. Get it from `mailchimp_lists_list`.

status_if_newstringrequiredStatus for new members: `subscribed`, `unsubscribed`, `cleaned`, `pending`.

subscriber_hashstringrequiredMD5 hash of the member's lowercase email address.

first_namestringoptionalFirst name (FNAME merge field).

last_namestringoptionalLast name (LNAME merge field).

statusstringoptionalStatus for existing members.

mailchimp_list_members_list#Return a list of members in a Mailchimp audience, with optional filters by status.7 params▾

Return a list of members in a Mailchimp audience, with optional filters by status.

NameTypeRequiredDescription

list_idstringrequiredThe ID of the audience. Get it from `mailchimp_lists_list`.

countintegeroptionalNumber of records per page (max 1000).

fieldsstringoptionalComma-separated fields to return.

offsetintegeroptionalNumber of records to skip.

sort_dirstringoptionalSort direction: `ASC` or `DESC`.

sort_fieldstringoptionalField to sort by: `last_changed` or `timestamp_opt`.

statusstringoptionalFilter by member status: `subscribed`, `unsubscribed`, `cleaned`, `pending`, `transactional`, `archived`.

mailchimp_list_update#Update an existing Mailchimp audience's name or settings.5 params▾

Update an existing Mailchimp audience's name or settings.

NameTypeRequiredDescription

list_idstringrequiredThe ID of the audience. Get it from `mailchimp_lists_list`.

from_emailstringoptionalUpdated sender email address.

from_namestringoptionalUpdated sender display name.

namestringoptionalNew name for the audience.

permission_reminderstringoptionalUpdated permission reminder.

mailchimp_lists_list#Return a list of all Mailchimp audiences (lists) in the account.5 params▾

Return a list of all Mailchimp audiences (lists) in the account.

NameTypeRequiredDescription

countintegeroptionalNumber of records to return per page (max 1000).

fieldsstringoptionalComma-separated fields to return.

offsetintegeroptionalNumber of records to skip.

sort_dirstringoptionalSort direction: `ASC` or `DESC`.

sort_fieldstringoptionalField to sort results by: `date_created` or `campaign_last_sent`.

mailchimp_ping#Check the health of the Mailchimp API. Returns a health status string.0 params▾

Check the health of the Mailchimp API. Returns a health status string.

mailchimp_report_click_details#Return click details and statistics for links in a Mailchimp campaign.3 params▾

Return click details and statistics for links in a Mailchimp campaign.

NameTypeRequiredDescription

campaign_idstringrequiredThe ID of the campaign. Get it from `mailchimp_campaigns_list`.

countintegeroptionalNumber of records per page.

offsetintegeroptionalNumber of records to skip.

mailchimp_report_email_activity#Return per-subscriber email activity for a specific Mailchimp campaign, including opens, clicks, and bounces.4 params▾

Return per-subscriber email activity for a specific Mailchimp campaign, including opens, clicks, and bounces.

NameTypeRequiredDescription

campaign_idstringrequiredThe ID of the campaign. Get it from `mailchimp_campaigns_list`.

countintegeroptionalNumber of records per page.

fieldsstringoptionalComma-separated fields to return.

offsetintegeroptionalNumber of records to skip.

mailchimp_report_get#Retrieve the report summary for a specific Mailchimp campaign, including opens, clicks, bounces, and unsubscribes.2 params▾

Retrieve the report summary for a specific Mailchimp campaign, including opens, clicks, bounces, and unsubscribes.

NameTypeRequiredDescription

campaign_idstringrequiredThe ID of the campaign. Get it from `mailchimp_campaigns_list`.

fieldsstringoptionalComma-separated fields to return.

mailchimp_report_open_details#Return a list of members who opened a specific Mailchimp campaign.3 params▾

Return a list of members who opened a specific Mailchimp campaign.

NameTypeRequiredDescription

campaign_idstringrequiredThe ID of the campaign. Get it from `mailchimp_campaigns_list`.

countintegeroptionalNumber of records per page.

offsetintegeroptionalNumber of records to skip.

mailchimp_report_unsubscribes#Return a list of members who unsubscribed from a specific Mailchimp campaign.3 params▾

Return a list of members who unsubscribed from a specific Mailchimp campaign.

NameTypeRequiredDescription

campaign_idstringrequiredThe ID of the campaign. Get it from `mailchimp_campaigns_list`.

countintegeroptionalNumber of records per page.

offsetintegeroptionalNumber of records to skip.

mailchimp_reports_list#Return a list of campaign reports in the Mailchimp account.4 params▾

Return a list of campaign reports in the Mailchimp account.

NameTypeRequiredDescription

countintegeroptionalNumber of records per page.

fieldsstringoptionalComma-separated fields to return.

offsetintegeroptionalNumber of records to skip.

typestringoptionalFilter by campaign type: `regular`, `absplit`, `variate`, `rss`, `plaintext`.

mailchimp_segment_create#Create a new static or saved segment in a Mailchimp audience.4 params▾

Create a new static or saved segment in a Mailchimp audience.

NameTypeRequiredDescription

list_idstringrequiredThe ID of the audience. Get it from `mailchimp_lists_list`.

namestringrequiredName of the segment.

optionsstringoptionalJSON object defining conditions for a saved segment. See Mailchimp docs for condition format.

static_segmentstringoptionalJSON array of email addresses to add to a static segment.

mailchimp_segment_delete#Delete a segment from a Mailchimp audience.2 params▾

Delete a segment from a Mailchimp audience.

NameTypeRequiredDescription

list_idstringrequiredThe ID of the audience. Get it from `mailchimp_lists_list`.

segment_idstringrequiredThe ID of the segment to delete. Get it from `mailchimp_segments_list`.

mailchimp_segment_get#Retrieve details about a specific segment in a Mailchimp audience.2 params▾

Retrieve details about a specific segment in a Mailchimp audience.

NameTypeRequiredDescription

list_idstringrequiredThe ID of the audience. Get it from `mailchimp_lists_list`.

segment_idstringrequiredThe ID of the segment. Get it from `mailchimp_segments_list`.

mailchimp_segment_members_list#Return a list of members in a specific segment of a Mailchimp audience.4 params▾

Return a list of members in a specific segment of a Mailchimp audience.

NameTypeRequiredDescription

list_idstringrequiredThe ID of the audience. Get it from `mailchimp_lists_list`.

segment_idstringrequiredThe ID of the segment. Get it from `mailchimp_segments_list`.

countintegeroptionalNumber of records per page.

offsetintegeroptionalNumber of records to skip.

mailchimp_segment_update#Update the name or conditions of a segment in a Mailchimp audience.4 params▾

Update the name or conditions of a segment in a Mailchimp audience.

NameTypeRequiredDescription

list_idstringrequiredThe ID of the audience. Get it from `mailchimp_lists_list`.

segment_idstringrequiredThe ID of the segment. Get it from `mailchimp_segments_list`.

namestringoptionalNew name for the segment.

static_segmentstringoptionalUpdated JSON array of emails for a static segment.

mailchimp_segments_list#Return a list of segments for a specific Mailchimp audience.5 params▾

Return a list of segments for a specific Mailchimp audience.

NameTypeRequiredDescription

list_idstringrequiredThe ID of the audience. Get it from `mailchimp_lists_list`.

countintegeroptionalNumber of records per page.

fieldsstringoptionalComma-separated fields to return.

offsetintegeroptionalNumber of records to skip.

typestringoptionalFilter by segment type: `static` or `saved`.

mailchimp_template_create#Create a new user-defined HTML template in Mailchimp.3 params▾

Create a new user-defined HTML template in Mailchimp.

NameTypeRequiredDescription

htmlstringrequiredThe HTML content for the template.

namestringrequiredA name for the template.

folder_idstringoptionalID of a folder to place the template in.

mailchimp_template_delete#Permanently delete a user-defined template from Mailchimp.1 param▾

Permanently delete a user-defined template from Mailchimp.

NameTypeRequiredDescription

template_idstringrequiredThe ID of the template to delete. Get it from `mailchimp_templates_list`.

mailchimp_template_get#Retrieve information about a specific template in the Mailchimp account.2 params▾

Retrieve information about a specific template in the Mailchimp account.

NameTypeRequiredDescription

template_idstringrequiredThe ID of the template. Get it from `mailchimp_templates_list`.

fieldsstringoptionalComma-separated fields to return.

mailchimp_template_update#Update a user-defined template's name or HTML content in Mailchimp.3 params▾

Update a user-defined template's name or HTML content in Mailchimp.

NameTypeRequiredDescription

template_idstringrequiredThe ID of the template. Get it from `mailchimp_templates_list`.

htmlstringoptionalNew HTML content for the template.

namestringoptionalNew name for the template.

mailchimp_templates_list#Return a list of templates in the Mailchimp account, including user-created and Mailchimp base templates.6 params▾

Return a list of templates in the Mailchimp account, including user-created and Mailchimp base templates.

NameTypeRequiredDescription

countintegeroptionalNumber of records per page.

fieldsstringoptionalComma-separated fields to return.

offsetintegeroptionalNumber of records to skip.

sort_dirstringoptionalSort direction: `ASC` or `DESC`.

sort_fieldstringoptionalSort field: `date_created`.

typestringoptionalFilter by template type: `user`, `base`, `gallery`.