Mailchimp
API integration

list_all_mailchimp_campaigns

List all Mailchimp campaigns in an account. Returns: id, web_id, parent_campaign_id, type, create_time, archive_url, long_archive_url, status, emails_sent, send_time, content_type, needs_block_refresh, resendable, recipients, settings, variate_settings, tracking, rss_opts, ab_split_opts, social_card, report_summary, delivery_status, resend_shortcut_eligibility, resend_shortcut_usage, _links,…

get_single_mailchimp_campaign_by_id

Get information about a specific Mailchimp campaign by id. Returns: id, web_id, parent_campaign_id, type, create_time, archive_url, long_archive_url, status, emails_sent, send_time, content_type, needs_block_refresh, resendable, recipients, settings, variate_settings, tracking, rss_opts, ab_split_opts, social_card, report_summary, delivery_status, resend_shortcut_eligibility,…

create_a_mailchimp_campaign

Create a new Mailchimp campaign. Returns the created campaign including id, type, status, create_time, recipients, and settings. Required: type. A/B Split campaigns have been deprecated; use variate instead.

update_a_mailchimp_campaign_by_id

Update some or all settings for a specific Mailchimp campaign by id. Returns the updated campaign including id, type, status, recipients, settings, and tracking. Required: id, settings.

delete_a_mailchimp_campaign_by_id

Delete a Mailchimp campaign by id. Returns an empty 204 response on success. Required: id.

mailchimp_campaigns_pause

Pause an RSS-Driven Mailchimp campaign. Returns an empty 204 response on success. Required: campaign_id.

mailchimp_campaigns_replicate

Replicate a Mailchimp campaign in saved or send status. Returns the new campaign object including id, web_id, type, status, create_time, send_time, recipients, and settings. Required: campaign_id.

mailchimp_campaigns_resume

Resume a paused RSS-Driven Mailchimp campaign. Returns an empty 204 response on success. Required: campaign_id.

mailchimp_campaigns_schedule

Schedule a Mailchimp campaign for delivery at a specific UTC time. Returns an empty 204 response on success. Required: campaign_id, schedule_time. Campaigns may only be scheduled on the quarter-hour (:00, :15, :30, :45). Use the send action instead for Multivariate Campaigns testing send times or RSS Campaigns.

mailchimp_campaigns_send

Send a Mailchimp campaign immediately, or according to its schedule for RSS campaigns. Returns an empty 204 response on success. Required: campaign_id.

mailchimp_campaigns_test

Send a test email for a Mailchimp campaign to specified recipients. Returns an empty 204 response on success. Required: campaign_id, test_emails, send_type.

mailchimp_campaigns_cancel_send

Cancel a Regular or Plain-Text Mailchimp campaign after sending, before all recipients receive it. This feature requires Mailchimp Pro. Returns an empty 204 response on success. Required: campaign_id.

mailchimp_campaigns_create_resend

Resend a Mailchimp campaign to a specific segment using a shortcut — non-openers, new subscribers, non-clickers, or non-purchasers. Returns the replicated Campaign object including id, type, status, recipients, send_time, and resendable. Required: campaign_id.

mailchimp_campaigns_unschedule

Unschedule a scheduled Mailchimp campaign that hasn't started sending. Returns an empty 204 response on success. Required: campaign_id.

list_all_mailchimp_campaign_folders

List Mailchimp campaign folders used to organize campaigns. Returns each folder's id, name, count, and _links. Use fields or exclude_fields to control which fields are returned.

get_single_mailchimp_campaign_folder_by_id

Get a single Mailchimp campaign folder by id. Returns: id, count, _links, x-title. Required: id.

create_a_mailchimp_campaign_folder

Create a new Mailchimp campaign folder. Returns: name, id, count, _links. Required: name.

update_a_mailchimp_campaign_folder_by_id

Update a Mailchimp campaign folder by id. Returns: id, count, _links. Required: id, name.

delete_a_mailchimp_campaign_folder_by_id

Delete a Mailchimp campaign folder by id. All campaigns in the deleted folder are marked as 'unfiled'. Returns an empty 204 response on success. Required: id.

list_all_mailchimp_files

List Mailchimp File Manager files stored in the account. Returns: id, folder_id, type, name, full_size_url, thumbnail_url, size, created_at, created_by, width, height, _links. Max 1000 records per page.

get_single_mailchimp_file_by_id

Get a single Mailchimp File Manager file by id. Returns: id, folder_id, type, name, full_size_url, thumbnail_url, size, created_at, created_by, width, height, _links. Required: id.

create_a_mailchimp_file

Upload a new image or file to the Mailchimp File Manager. Returns the created file object including id, name, type, full_size_url, size, and created_at. Required: name, file_data.

update_a_mailchimp_file_by_id

Update a Mailchimp File Manager file's name or folder by id. Returns the updated file object including id, name, folder_id, type, full_size_url, and size. Setting folder_id to 0 removes the file from its current folder. Required: id.

list_all_mailchimp_file_folders

List all folders in the Mailchimp File Manager. Returns: id, name, file_count, created_at, created_by, _links. Supports filtering by created_by, before_created_at, and since_created_at.

get_single_mailchimp_file_folder_by_id

Get a specific Mailchimp File Manager folder by id. Returns: id, name, file_count, created_at, created_by, _links. Required: id.

create_a_mailchimp_file_folder

Create a new folder in the Mailchimp File Manager. Returns: id, name, file_count, created_at, created_by, _links. Required: name.

update_a_mailchimp_file_folder_by_id

Update a specific Mailchimp File Manager folder by id. Returns: id, name, file_count, created_at, created_by, _links. Required: id.

list_all_mailchimp_templates

List Mailchimp email templates for an account, with optional filters by creator, date range, type, category, folder, and content_type. Returns: id, type, name, drag_and_drop, responsive, category, date_created, date_edited, created_by, edited_by, active, folder_id, thumbnail, share_url, content_type, _links. Sort by date_created, date_edited, or name in ascending or descending order. Max 1000…

get_single_mailchimp_template_by_id

Get a single Mailchimp email template by id. Returns: id, type, drag_and_drop, responsive, category, date_created, date_edited, created_by, edited_by, active, folder_id, thumbnail, share_url, content_type, _links, x-title. Required: id.

create_a_mailchimp_template

Add template. Returns: id, type, name, drag_and_drop, responsive, category, date_created, date_edited. Required: name, html.

update_a_mailchimp_template_by_id

Update template. Returns: id, type, name, drag_and_drop, responsive, category, date_created, date_edited. Required: id, name, html.

delete_a_mailchimp_template_by_id

Delete a Mailchimp template by id. Returns an empty 204 response on success. Required: id.

list_all_mailchimp_template_folders

List Mailchimp template folders used to organize templates. Returns each folder with id, name, count, and _links. Max 1000 records per page.

get_single_mailchimp_template_folder_by_id

Get a single Mailchimp template folder by id. Returns: id, count, _links, x-title. Required: id.

create_a_mailchimp_template_folder

Create a new Mailchimp template folder. Returns: name, id, count, _links. Required: name.

update_a_mailchimp_template_folder_by_id

Update a Mailchimp template folder by id. Returns: id, count, _links. Required: id.

delete_a_mailchimp_template_folder_by_id

Delete a Mailchimp template folder by id. All templates previously in the folder are marked as 'unfiled'. Returns an empty 204 response on success. Required: id.

list_all_mailchimp_lists

List all Mailchimp subscriber lists (audiences) in the account. Returns each list with id, name, web_id, date_created, list_rating, contact, campaign_defaults, stats, and subscribe URLs. Filter by creation date, campaign send date, subscriber email, or ecommerce store connection; sort by date_created ascending or descending. Max 1000 records per page.

get_single_mailchimp_list_by_id

Get a single Mailchimp subscriber list (audience) by id. Returns the full list object including id, name, web_id, date_created, list_rating, contact, campaign_defaults, stats, and subscribe URLs. Required: id.

create_a_mailchimp_list

Create a new list in Mailchimp. Returns the created list including id, web_id, name, contact, campaign_defaults, date_created, list_rating, stats, visibility, and subscribe URLs. Required: name, permission_reminder, email_type_option, contact, campaign_defaults.

update_a_mailchimp_list_by_id

Update the settings for a specific Mailchimp list by id. Returns the updated list including id, web_id, name, contact, campaign_defaults, date_created, list_rating, stats, and visibility. Required: id, name, permission_reminder, email_type_option, contact, campaign_defaults.

delete_a_mailchimp_list_by_id

Delete a Mailchimp list by id. Permanently removes all list history including subscriber activity, unsubscribes, complaints, bounces, and subscriber email addresses. Returns an empty 204 response on success. Required: id.

mailchimp_lists_list_activity

List up to 180 days of daily aggregated activity stats for a Mailchimp list, excluding Automation activity. Returns: day, emails_sent, unique_opens, recipient_clicks, hard_bounce, soft_bounce, subs, unsubs, other_adds, other_removes, _links. Required: list_id.

mailchimp_lists_list_webhooks

List all webhooks configured for a specific Mailchimp list. Returns: id, url, events, sources, list_id, _links. Required: list_id.

mailchimp_lists_attach_webhook

Create a new webhook for a specific Mailchimp list. Returns the created webhook including id, url, events, sources, list_id, and _links. Required: list_id.

list_all_mailchimp_members

List members of a specific Mailchimp list, including currently subscribed, unsubscribed, and bounced members. Returns: id, email_address, unique_email_id, contact_id, full_name, web_id, email_type, status, unsubscribe_reason, consents_to_one_to_one_messaging, sms_phone_number, sms_subscription_status, sms_subscription_last_updated, merge_fields, interests, stats, ip_signup, timestamp_signup,…

get_single_mailchimp_member_by_id

Get information about a specific Mailchimp list member by id, including currently subscribed, unsubscribed, or bounced members. Returns: id, email_address, unique_email_id, contact_id, full_name, web_id, email_type, status, unsubscribe_reason, consents_to_one_to_one_messaging, sms_phone_number, sms_subscription_status, sms_subscription_last_updated, merge_fields, interests, stats, ip_signup,…

create_a_mailchimp_member

Add a new member to a Mailchimp list. Returns: id, email_address, unique_email_id, contact_id, full_name, web_id, email_type, status, unsubscribe_reason, consents_to_one_to_one_messaging, sms_phone_number, sms_subscription_status, sms_subscription_last_updated, merge_fields, interests, stats, ip_signup, timestamp_signup, ip_opt, timestamp_opt, member_rating, last_changed, language, vip,…

update_a_mailchimp_member_by_id

Update information for a specific Mailchimp list member. Returns: id, email_address, unique_email_id, contact_id, full_name, web_id, email_type, status, unsubscribe_reason, consents_to_one_to_one_messaging, sms_phone_number, sms_subscription_status, sms_subscription_last_updated, merge_fields, interests, stats, ip_signup, timestamp_signup, ip_opt, timestamp_opt, member_rating, last_changed,…

mailchimp_members_search

Search for Mailchimp list members by email address or contact name, optionally restricted to a specific list. Returns: exact_matches, full_search, _links. Required: query.

mailchimp_members_upsert

Add or update a list member in Mailchimp by email address — creates a new subscriber if the address is not yet on the list, or updates the existing member if it is. Returns the full member object including id, email_address, status, merge_fields, vip, and tags. Required: list_id, email_address, status_if_new.

list_all_mailchimp_tags

Search for tags on a Mailchimp list by name. Returns: id, name. If no name query is provided, all tags on the list are returned. Required: list_id.

list_all_mailchimp_accounts

List Mailchimp account details from the Marketing API root. Returns: account_id, login_id, account_name, email, account_role, pricing_plan_type, first_name, last_name, member_count, total_subscribers. Optional fields and exclude_fields query parameters control which fields are returned.

list_all_mailchimp_oauth_metadata

Get Mailchimp OAuth metadata for the authenticated user. Returns the server prefix (dc) needed to route all subsequent Marketing API requests on the user's behalf. No request parameters required.

list_all_mailchimp_account_exports

List Mailchimp account exports. Returns: export_id, started, finished, size_in_bytes, download_url, _links. Max 1000 records per page.

create_a_mailchimp_account_export

Create a new account export in your Mailchimp account. Returns: export_id, started, finished, size_in_bytes, download_url, _links. Required: include_stages.

get_single_mailchimp_account_export_by_id

Get information about a specific Mailchimp account export by id. Returns: export_id, started, finished, size_in_bytes, download_url, _links, x-title. Required: id.

list_all_mailchimp_activity_feed_chimp_chatters

List Mailchimp chimp chatter activity feed messages ordered by most recent. Returns: title, message, type, update_time, url, list_id, campaign_id. A maximum of 200 messages exist per account and up to 1000 can be returned per request.

list_all_mailchimp_audience_contacts

List Mailchimp audience contacts with optional date-range and sort filters. Returns each contact's id, audience_id, language, status, email_channel, sms_channel, merge_fields, tags, source, created_at, and last_updated_at. Required: audience_id. Max 1000 records per page.

create_a_mailchimp_audience_contact

Create a new omni-channel contact in a Mailchimp audience. Returns the created contact including id, audience_id, language, status, email_channel, sms_channel, merge_fields, tags, source, created_at, and last_updated_at. Required: audience_id.

get_single_mailchimp_audience_contact_by_id

Get a single Mailchimp audience contact by id. Returns the full contact including id, audience_id, language, status, email_channel, sms_channel, merge_fields, tags, source, created_at, and last_updated_at. Required: audience_id, id.

mailchimp_audience_contacts_bulk_update

Update an existing Mailchimp audience contact by contact_id. Returns the updated contact including id, audience_id, language, status, email_channel, sms_channel, merge_fields, tags, source, created_at, and last_updated_at. Required: audience_id, contact_id.

mailchimp_audience_contacts_archive

Archive a Mailchimp audience contact by contact_id. Returns an empty 204 response on success. Required: audience_id, contact_id.

mailchimp_audience_contacts_forget

Forget a Mailchimp contact within a specific audience, removing the contact's personal data in compliance with privacy regulations. Returns an empty 204 response on success. Required: audience_id, contact_id.

list_all_mailchimp_audiences

List Mailchimp audiences in the account. Returns each audience with id, name, stats, and enabled_channels. Max 1000 records per page.

get_single_mailchimp_audience_by_id

Get a specific Mailchimp audience by id. Returns: id, stats, enabled_channels, x-title. Required: id.

list_all_mailchimp_authorized_apps

List Mailchimp authorized (registered, connected) applications for an account. Returns: id, name, description, users, _links. Max 1000 records per page.

get_single_mailchimp_authorized_app_by_id

Get information about a specific Mailchimp authorized application by id. Returns: id, description, users, _links, x-title. Required: id.

list_all_mailchimp_automation_emails

List automated emails in a Mailchimp classic automation workflow. Returns each email with id, web_id, workflow_id, position, delay, create_time, start_time, archive_url, status, emails_sent, send_time, content_type, recipients, and related settings. Required: workflow_id.

get_single_mailchimp_automation_email_by_id

Get information about a specific Mailchimp automation workflow email. Returns the full email object including id, web_id, workflow_id, position, delay, create_time, start_time, archive_url, status, emails_sent, send_time, content_type, recipients, and related settings. Required: workflow_id, id.

mailchimp_automation_emails_bulk_update

Update workflow email. Returns: id, web_id, workflow_id, position, delay, create_time, start_time, archive_url. Required: workflow_id, workflow_email_id.

mailchimp_automation_emails_bulk_delete

Delete an individual classic automation workflow email in Mailchimp. Emails from certain workflow types, including Abandoned Cart Email and Product Retargeting Email workflows, cannot be deleted. Returns an empty 204 response on success. Required: workflow_id, workflow_email_id.

mailchimp_automation_emails_pause

Pause an automated email in a Mailchimp classic automation workflow. Returns an empty 204 response on success. Required: workflow_id, workflow_email_id.

mailchimp_automation_emails_start

Start a Mailchimp automated email, triggering it to begin sending. Returns an empty 204 response on success. Required: workflow_id, workflow_email_id.

list_all_mailchimp_automation_removed_subscribers

List subscribers who were removed from a Mailchimp classic automation workflow. Returns: id, workflow_id, list_id, email_address, _links. Required: workflow_id.

create_a_mailchimp_automation_removed_subscriber

Remove a subscriber from a Mailchimp classic automation workflow. Once removed, the subscriber can never be added back to the same workflow. Returns: id, workflow_id, list_id, email_address, _links. Required: workflow_id, email_address.

list_all_automation_removed_subscribers_removed_subscribers

Get information about a specific Mailchimp subscriber who was removed from a classic automation workflow. Returns: id, workflow_id, list_id, email_address, _links, fired_at, data. Required: workflow_id, subscriber_hash.

list_all_mailchimp_automations

List Mailchimp classic automations with optional filtering by creation/start time and status. Returns each automation's id, create_time, start_time, status, emails_sent, and recipients.

create_a_mailchimp_automation

Create a new classic automation in your Mailchimp account. Returns the created automation including id, create_time, start_time, status, emails_sent, and recipients. Required: recipients, trigger_settings.

get_single_mailchimp_automation_by_id

Get a single Mailchimp classic automation workflow by id. Returns: id, create_time, start_time, status, emails_sent, recipients, settings, tracking, trigger_settings, report_summary, _links. Required: id.

mailchimp_automations_pause_all_emails

Pause all emails in a specific Mailchimp classic automation workflow. Returns an empty 204 response on success. Required: workflow_id.

mailchimp_automations_start_all_emails

Start all emails in a Mailchimp classic automation workflow. Returns an empty 204 response on success. Required: workflow_id.

mailchimp_automations_archive

Archive a Mailchimp automation workflow, permanently ending it. Report data is retained and the workflow can be replicated but not restarted. Returns an empty 204 response on success. Required: workflow_id.

list_all_mailchimp_batch_webhooks

List all Mailchimp batch webhooks configured for batch request completion notifications. Returns: id, url, enabled, _links.

create_a_mailchimp_batch_webhook

Create a new Mailchimp batch webhook that fires whenever any batch request completes processing. Returns: id, url, enabled, _links. Required: url. Maximum of 20 batch webhooks allowed.

get_single_mailchimp_batch_webhook_by_id

Get information about a specific Mailchimp batch webhook by id. Returns: id, url, enabled, _links, x-title. Required: id.

update_a_mailchimp_batch_webhook_by_id

Update a Mailchimp batch webhook's URL or enabled status by id. Returns: id, url, enabled, _links. Required: id.

delete_a_mailchimp_batch_webhook_by_id

Delete a Mailchimp batch webhook by id. Webhooks will no longer be sent to the configured URL. Returns an empty 204 response on success. Required: id.

list_all_mailchimp_batches

List Mailchimp batch requests. Returns: id, status, total_operations, finished_operations, errored_operations, submitted_at, completed_at, response_body_url, _links. Max 1000 records per page.

create_a_mailchimp_batch

Start a Mailchimp batch operation by submitting an array of operations. Returns: id, status, total_operations, finished_operations, errored_operations, submitted_at, completed_at, response_body_url, _links. Required: operations.

get_single_mailchimp_batch_by_id

Get the status of a Mailchimp batch request by id. Returns: id, status, total_operations, finished_operations, errored_operations, submitted_at, completed_at, response_body_url, _links, x-title. Required: id.

delete_a_mailchimp_batch_by_id

Stop a Mailchimp batch request from running by id. Results of any completed operations will not be available after deletion. Returns an empty 204 response on success. Required: id.

list_all_mailchimp_email_queues

List subscribers in a Mailchimp classic automation email queue. Returns: id, workflow_id, email_id, list_id, email_address, next_send, _links. Required: workflow_id, workflow_email_id.

create_a_mailchimp_email_queue

Manually add a subscriber to a Mailchimp automation workflow email, bypassing the default trigger settings. Returns: id, workflow_id, email_id, list_id, list_is_active, email_address, next_send, _links. Required: workflow_id, workflow_email_id, email_address.

list_all_mailchimp_email_queues_queue

Get information about a specific subscriber in a Mailchimp classic automation email queue. Returns: id, workflow_id, email_id, list_id, list_is_active, email_address, next_send, _links, fired_at, data. Required: workflow_id, workflow_email_id, subscriber_hash.

list_all_mailchimp_campaign_feedbacks

List team feedback for a Mailchimp campaign. Returns: feedback_id, parent_id, block_id, message, is_complete, created_by, created_at, updated_at, source, campaign_id, _links. Required: campaign_id.

get_single_mailchimp_campaign_feedback_by_id

Get a specific feedback message from a Mailchimp campaign by id. Returns: feedback_id, parent_id, block_id, message, is_complete, created_by, created_at, updated_at, source, campaign_id, _links, fired_at, data. Required: campaign_id, id.

create_a_mailchimp_campaign_feedback

Add feedback to a Mailchimp campaign. Returns the created feedback object including feedback_id, message, is_complete, created_by, created_at, source, and campaign_id. Required: campaign_id, message.

mailchimp_campaign_feedbacks_bulk_update

Update a specific feedback message for a Mailchimp campaign. Returns the updated feedback object including feedback_id, message, is_complete, created_by, created_at, updated_at, source, and campaign_id. Required: campaign_id, feedback_id.

mailchimp_campaign_feedbacks_bulk_delete

Delete a specific feedback message from a Mailchimp campaign. Returns an empty 204 response on success. Required: campaign_id, feedback_id.

list_all_mailchimp_campaign_send_checklists

Get the send checklist for a Mailchimp campaign to review readiness and resolve any issues before sending. Returns: is_ready, items, _links, x-title. Required: campaign_id.

list_all_mailchimp_connected_sites

List all connected sites in a Mailchimp account. Returns each site's foreign_id, domain, platform, store_id, site_script, is_pixel_enabled, created_at, and updated_at.

get_single_mailchimp_connected_site_by_id

Get a specific Mailchimp connected site by id. Returns: foreign_id, store_id, platform, domain, site_script, is_pixel_enabled, created_at, updated_at, _links, x-title. Required: id.

create_a_mailchimp_connected_site

Create a new Mailchimp connected site. Returns: foreign_id, store_id, platform, domain, site_script, is_pixel_enabled, created_at, updated_at, _links. Required: foreign_id, domain.

delete_a_mailchimp_connected_site_by_id

Delete a Mailchimp connected site by id. Returns an empty 204 response on success. Required: id.

mailchimp_connected_sites_verify_script_installation

Verify that the Mailchimp connected sites script has been installed, either via the script URL or fragment. Returns an empty 204 response on success. Required: connected_site_id.

mailchimp_connected_sites_enable_pixel

Enable the Mailchimp tracking pixel for a connected site. Returns an empty 204 response on success. Required: connected_site_id.

mailchimp_connected_sites_disable_pixel

Disable the Mailchimp tracking pixel for a connected site. Returns an empty 204 response on success. Required: connected_site_id.

list_all_mailchimp_contents

Get the HTML and plain-text content for a Mailchimp campaign. Returns: variate_contents, plain_text, html, archive_html, _links, x-title. Required: campaign_id.

mailchimp_contents_bulk_update

Set the HTML and plain-text content for a Mailchimp campaign, with support for templates, archives, URLs, and multivariate content options. Returns: variate_contents, plain_text, html, archive_html, _links. Required: campaign_id.

list_all_mailchimp_conversations

List Mailchimp conversations for the account. Returns: id, message_count, campaign_id, list_id, unread_messages, from_label, from_email, subject, last_message, _links. Conversations are deprecated in favor of Inbox; past conversations remain but new campaign replies are excluded.

get_single_mailchimp_conversation_by_id

Get a single Mailchimp conversation by id. Returns: id, message_count, campaign_id, list_id, unread_messages, from_label, from_email, subject, last_message, _links, x-title. Required: id. Deprecated in favor of Inbox.

mailchimp_conversations_list_messages

List messages from a specific Mailchimp conversation. Returns: id, conversation_id, list_id, from_label, from_email, subject, message, read, timestamp, _links. Required: conversation_id. Deprecated in favor of Inbox.

list_all_mailchimp_conversation_messages

Get an individual Mailchimp conversation message by conversation and message id. Returns: id, conversation_id, list_id, from_label, from_email, subject, message, read, timestamp, _links, x-title. Required: conversation_id, message_id. Conversations has been deprecated in favor of Inbox; new campaign replies and Inbox messages are not available via this endpoint.

delete_a_mailchimp_file_manager_file_by_id

Delete a Mailchimp File Manager file by id. Returns an empty 204 response on success. Required: id.

delete_a_mailchimp_file_manager_folder_by_id

Delete a Mailchimp File Manager folder by id. Returns an empty 204 response on success. Required: id.

list_all_mailchimp_folder_files

List images and files stored in a Mailchimp File Manager folder. Returns each file with id, name, type, full_size_url, thumbnail_url, size, and created_at. Required: folder_id.

list_all_mailchimp_interest_categorie_interests

List Mailchimp interests (group names) within a specific interest category. Returns: category_id, list_id, id, name, subscriber_count, display_order, _links. Required: list_id, interest_category_id.

get_single_mailchimp_interest_categorie_interest_by_id

Get a single Mailchimp interest (group name) by id within a specific category. Returns: category_id, list_id, id, name, subscriber_count, display_order, _links, fired_at, data. Required: list_id, interest_category_id, id.

create_a_mailchimp_interest_categorie_interest

Create a new Mailchimp interest (group name) in a specific category. Returns: category_id, list_id, id, subscriber_count, display_order, _links, x-title, name. Required: list_id, interest_category_id, name.

mailchimp_interest_categorie_interests_bulk_update

Update a Mailchimp interest (group name) by interest_id within a specific category. Returns: category_id, list_id, id, name, subscriber_count, display_order, _links, fired_at, data. Required: list_id, interest_category_id, interest_id.

mailchimp_interest_categorie_interests_bulk_delete

Delete a Mailchimp interest (group name) by interest_id from a specific category. Returns an empty 204 response on success. Required: list_id, interest_category_id, interest_id.

mailchimp_journey_steps_trigger

Trigger a Mailchimp Customer Journeys API step for a contact in an Automation flow. The journey_id and step_id are obtained from the URL Mailchimp provides when you create a Customer Journey API starting point or step in the flow builder. Returns an empty 204 response on success. Required: journey_id, step_id, email_address.

list_all_mailchimp_list_abuse_reports

List Mailchimp abuse reports for a specific list. Returns: id, campaign_id, list_id, email_id, email_address, merge_fields, vip, date, _links. Required: list_id.

get_single_mailchimp_list_abuse_report_by_id

Get a specific Mailchimp abuse report by id. Returns: id, campaign_id, list_id, email_id, email_address, merge_fields, vip, date, _links. Required: list_id, id.

list_all_mailchimp_list_clients

List the top email clients used by subscribed members of a Mailchimp list, based on user-agent strings. Returns: client, members. Required: list_id.

list_all_mailchimp_list_growth_histories

List month-by-month growth history for a Mailchimp list. Returns: list_id, month, existing, imports, optins, subscribed, unsubscribed, reconfirm, cleaned, pending, deleted, transactional, _links. Required: list_id. The existing, imports, and optins fields are deprecated.

list_all_mailchimp_list_growth_histories_growth_history

Get a Mailchimp list's growth history for a specific month and year. Returns: list_id, month, existing, imports, optins, subscribed, unsubscribed, reconfirm, cleaned, pending, deleted, transactional, _links. Required: list_id, month.

list_all_mailchimp_list_interest_categories

List Mailchimp interest categories for a specific list. Returns each category with id, list_id, title, display_order, and type. Required: list_id.

get_single_mailchimp_list_interest_category_by_id

Get a single Mailchimp interest category by id. Returns: list_id, id, title, display_order, type, _links, fired_at, data. Required: list_id, id.

create_a_mailchimp_list_interest_category

Create a new interest category for a Mailchimp list. Returns the created category including id, list_id, title, display_order, type, and _links. Required: list_id, title, type.

mailchimp_list_interest_categories_bulk_update

Update a specific Mailchimp interest category. Returns the updated category including id, list_id, title, display_order, type, and _links. Required: list_id, interest_category_id.

mailchimp_list_interest_categories_bulk_delete

Delete a specific Mailchimp interest category. Returns an empty 204 response on success. Required: list_id, interest_category_id.

list_all_mailchimp_list_segments

List Mailchimp segments for a specific list, with optional filtering by segment type, creation/update timestamps, and member status inclusion. Returns: id, name, member_count, type, created_at, updated_at, options, list_id, _links. Required: list_id. Max 1000 records per page.

get_single_mailchimp_list_segment_by_id

Get a single Mailchimp segment by id. Returns: id, name, member_count, type, created_at, updated_at, options, list_id, _links. Required: list_id, id.

create_a_mailchimp_list_segment

Create a new Mailchimp segment in a specific list. Returns the created segment including id, name, member_count, type, created_at, updated_at, and options. Required: list_id, name. The static_segment and options fields are mutually exclusive.

update_a_mailchimp_list_segment_by_id

Update a specific Mailchimp segment by id. Returns the updated segment including id, name, member_count, type, created_at, updated_at, and options. Required: list_id, id, name. The static_segment and options fields are mutually exclusive.

mailchimp_list_segments_attach_member

Add a member to a Mailchimp static segment. Returns the list member object including id, email_address, full_name, status, unique_email_id, and member_rating. Required: list_id, segment_id, email_address.

mailchimp_list_segments_bulk_update

Update segment. Returns: id, name, member_count, type, created_at, updated_at, options, list_id. Required: list_id, segment_id, name.

mailchimp_list_segments_bulk_delete

Delete a specific segment in a Mailchimp list. Returns an empty 204 response on success. Required: list_id, segment_id.

mailchimp_list_segments_list_members

List Mailchimp list members belonging to a saved segment. Returns: id, email_address, full_name, unique_email_id, email_type, status, merge_fields, interests, stats, ip_signup, timestamp_signup, ip_opt, timestamp_opt, member_rating, last_changed, language, vip, email_client, location, last_note, list_id, _links. Required: list_id, segment_id. Max 1000 per page.

update_a_mailchimp_lists_3_0_by_id

Batch subscribe or unsubscribe. Returns: new_members, updated_members, errors, total_created, total_updated, error_count, _links. Required: id, members.

list_all_mailchimp_landing_page_contents

Get the HTML content for a Mailchimp landing page by page_id. Returns: html, json, _links, x-title. Required: page_id.

list_all_mailchimp_landing_pages

List Mailchimp landing pages with optional sorting and field selection. Returns: id, name, title, description, template_id, status, list_id, store_id, web_id, created_by_source, url, created_at, published_at, unpublished_at, updated_at, tracking, _links. Max 1000 records per page.

get_single_mailchimp_landing_page_by_id

Get a single Mailchimp landing page by id. Returns: id, title, description, template_id, status, list_id, store_id, web_id, created_by_source, url, created_at, published_at, unpublished_at, updated_at, tracking, _links, x-title. Required: id.

create_a_mailchimp_landing_page

Create an unpublished, contentless Mailchimp landing page. Returns: id, title, description, template_id, status, list_id, store_id, web_id, created_by_source, url, created_at, published_at, unpublished_at, updated_at, tracking, _links, x-title.

update_a_mailchimp_landing_page_by_id

Update a Mailchimp landing page by id. Returns: id, title, description, template_id, status, list_id, store_id, web_id, created_by_source, url, created_at, published_at, unpublished_at, updated_at, tracking, _links, x-title. Required: id.

delete_a_mailchimp_landing_page_by_id

Delete a Mailchimp landing page by id. Returns an empty 204 response on success. Required: id.

mailchimp_landing_pages_publish

Publish a Mailchimp landing page that is in draft, unpublished, or has been previously published and edited. Returns an empty 204 response on success. Required: page_id.

mailchimp_landing_pages_unpublish

Unpublish a Mailchimp landing page that is in draft or has been published. Returns an empty 204 response on success. Required: page_id.

list_all_mailchimp_list_locations

List Mailchimp subscriber locations (countries) for a list, based on geocoding subscribers' IP addresses. Returns: country, cc, percent, total. Required: list_id.

mailchimp_list_members_attach_event

Add an event for a Mailchimp list member. Returns an empty 204 response on success. Required: list_id, subscriber_hash, name. The event name must be 2-30 characters in length.

mailchimp_list_members_attach_tag

Add or remove tags on a Mailchimp list member. Returns an empty 204 response on success. Required: list_id, subscriber_hash, tags. New tags are created automatically when set to active.

mailchimp_list_members_bulk_delete

Archive a Mailchimp list member. Returns an empty 204 response on success. Required: list_id, subscriber_hash. Use delete-permanent to permanently remove a member.

mailchimp_list_members_delete_permanent

Permanently delete a Mailchimp list member and all associated personally identifiable information. Returns an empty 204 response on success. Required: list_id, subscriber_hash. Re-importing the member is not possible after this action.

mailchimp_list_members_list_activity

List the last 50 activity events for a Mailchimp list member, including opens, clicks, and unsubscribes. Returns: action, timestamp, url, type, campaign_id, title, parent_campaign. Required: list_id, subscriber_hash.

mailchimp_list_members_list_events

List events for a Mailchimp list member. Returns: occurred_at, name, properties. Required: list_id, subscriber_hash. Max 1000 records per page.

mailchimp_list_members_list_tags

List tags assigned to a Mailchimp list member. Returns: id, name, date_added. Required: list_id, subscriber_hash. Max 1000 records per page.

list_all_mailchimp_list_merge_fields

List all merge fields for a Mailchimp audience, filterable by type and required status. Returns: merge_id, tag, name, type, required, default_value, public, display_order, options, help_text, list_id, total_items, merge_field_limit, _links. Required: list_id.

get_single_mailchimp_list_merge_field_by_id

Get information about a specific Mailchimp merge field. Returns: merge_id, tag, name, type, required, default_value, public, display_order, options, help_text, list_id, total_items, merge_field_limit, _links, fired_at, data. Required: list_id, id.

create_a_mailchimp_list_merge_field

Create a new merge field for a Mailchimp audience. Returns the created merge field including merge_id, tag, name, type, required, default_value, public, display_order, options, help_text, list_id, total_items, merge_field_limit, and _links. Required: list_id, name, type.

mailchimp_list_merge_fields_bulk_update

Update a specific Mailchimp merge field for a list. Returns the updated merge field including merge_id, tag, name, type, required, default_value, public, display_order, options, help_text, list_id, total_items, merge_field_limit, and _links. Required: list_id, merge_id, name.

mailchimp_list_merge_fields_bulk_delete

Delete a specific Mailchimp merge field. Returns an empty 204 response on success. Required: list_id, merge_id.

list_all_mailchimp_list_signup_forms

List signup forms for a specific Mailchimp list. Returns: header, contents, styles, signup_form_url, list_id, _links. Required: list_id.

create_a_mailchimp_list_signup_form

Customize a Mailchimp list's default signup form by setting header options, body content, and element styles. Returns: header, contents, styles, signup_form_url, list_id, _links, x-title. Required: list_id.

list_all_mailchimp_list_surveys

List all Mailchimp surveys for a specific audience list. Returns each survey with its id, title, and sections. Required: list_id.

get_single_mailchimp_list_survey_by_id

Get details about a specific Mailchimp survey by id. Returns: id, title, sections. Required: list_id, id.

create_a_mailchimp_list_survey

Create a draft Mailchimp survey for an audience. Returns the created survey including its id, title, and sections. Required: list_id.

mailchimp_list_surveys_bulk_update

Update a Mailchimp survey's title, inbox piping setting, and full section list. Returns: id, title, is_piped_to_inbox, sections. Required: list_id, survey_id. When sections is provided, send the complete list in display order—any section omitted is deleted.

mailchimp_list_surveys_bulk_delete

Delete a Mailchimp survey associated with a specific list. Returns an empty 204 response on success. Required: list_id, survey_id.

mailchimp_list_surveys_publish

Publish a Mailchimp survey that is in draft, unpublished, or has been previously published and edited. Returns an empty response on success. Required: list_id, survey_id.

mailchimp_list_surveys_unpublish

Unpublish a Mailchimp survey that has been published. Returns an empty response on success. Required: list_id, survey_id.

mailchimp_list_surveys_create_email

Create a Mailchimp survey campaign linked to a survey using the list and survey IDs. Returns the campaign object including id, web_id, type, status, create_time, and archive_url. Required: list_id, survey_id.

mailchimp_list_surveys_replicate

Replicate survey. Required: list_id, survey_id.

list_all_mailchimp_list_webhooks

Get information about a specific Mailchimp list webhook. Returns: id, url, events, sources, list_id, _links, x-title. Required: list_id, webhook_id.

mailchimp_list_webhooks_bulk_update

Update the settings for an existing Mailchimp list webhook. Returns the updated webhook object including id, url, events, sources, and list_id. Required: list_id, webhook_id.

mailchimp_list_webhooks_bulk_delete

Delete a specific Mailchimp list webhook. Returns an empty 204 response on success. Required: list_id, webhook_id.

list_all_mailchimp_member_activity_feeds

List a Mailchimp list member's recent activity including opens, clicks, bounces, and unsubscribes. Returns: activity_type, created_at_timestamp, campaign_id, campaign_title, link_clicked, bounce_type, bounce_has_open_activity, is_admin_unsubscribed, unsubscribe_reason, thread_id, message_text, created_by, is_user, has_read, from_email, avatar_url, updated_at_timestamp, note_id, note_text,…

list_all_mailchimp_member_goals

List the last 50 Mailchimp goal events for a member on a specific list. Returns: goal_id, event, last_visited_at, data. Required: list_id, subscriber_hash. Limited to the most recent 50 goal events.

list_all_mailchimp_member_notes

List recent member notes for a specific Mailchimp list member. Returns: id, created_at, created_by, updated_at, note, list_id, email_id, contact_id, _links. Required: list_id, subscriber_hash.

get_single_mailchimp_member_note_by_id

Get a specific Mailchimp member note by id. Returns: id, created_at, created_by, updated_at, note, list_id, email_id, contact_id, _links, title, status, detail, instance. Required: list_id, subscriber_hash, id.

create_a_mailchimp_member_note

Create a new note for a specific Mailchimp list member. Returns the created note object including id, created_at, created_by, updated_at, note, list_id, email_id, and contact_id. Required: list_id, subscriber_hash.

mailchimp_member_notes_bulk_update

Update a specific Mailchimp member note. Returns the updated note object including id, created_at, created_by, updated_at, note, list_id, email_id, and contact_id. Required: list_id, subscriber_hash, note_id.

mailchimp_member_notes_bulk_delete

Delete a specific Mailchimp member note. Returns an empty 204 response on success. Required: list_id, subscriber_hash, note_id.

list_all_mailchimp_report_abuse_reports

List abuse complaint reports for a specific Mailchimp campaign. Returns: id, campaign_id, list_id, list_is_active, email_id, email_address, merge_fields, vip, date, _links. Required: campaign_id.

get_single_mailchimp_report_abuse_report_by_id

Get a single Mailchimp abuse report for a specific campaign by id. Returns: id, campaign_id, list_id, list_is_active, email_id, email_address, merge_fields, vip, date, _links. Required: campaign_id, id.

list_all_mailchimp_reports

List Mailchimp campaign reports for sent campaigns. Returns per-report: id, campaign_title, type, list_id, list_name, subject_line, emails_sent, send_time, bounces, opens, clicks, forwards, abuse_reports, unsubscribed, industry_stats, list_stats, and ab_split stats. Filter by campaign type or send-time range. Max 1000 records per page.

get_single_mailchimp_report_by_id

Get a Mailchimp campaign report for a specific sent campaign by id. Returns: id, campaign_title, type, list_id, list_is_active, list_name, subject_line, preview_text, emails_sent, abuse_reports, unsubscribed, send_time, rss_last_send, bounces, forwards, opens, clicks, facebook_likes, industry_stats, list_stats, ab_split, timewarp, timeseries, share_report, ecommerce, delivery_status, _links,…

mailchimp_segment_members_bulk_delete

Remove a Mailchimp list member from a specified static segment. Returns an empty 204 response on success. Required: list_id, segment_id, subscriber_hash.

list_all_mailchimp_cart_lines

List Mailchimp cart line items for a specific cart. Returns: id, product_id, product_title, product_variant_id, product_variant_title, quantity, price, _links. Required: store_id, cart_id. Max 1000 records per page.

get_single_mailchimp_cart_line_by_id

Get a single Mailchimp cart line item by id. Returns: id, product_id, product_title, product_variant_id, product_variant_title, quantity, price, _links. Required: store_id, cart_id, id.

create_a_mailchimp_cart_line

Add a new line item to an existing Mailchimp cart. Returns: id, product_id, product_title, product_variant_id, product_variant_title, quantity, price, _links, x-title. Required: store_id, cart_id, id, product_id, product_variant_id, quantity, price.

mailchimp_cart_lines_bulk_update

Update a specific Mailchimp cart line item. Returns: id, product_id, product_title, product_variant_id, product_variant_title, quantity, price, _links. Required: store_id, cart_id, line_id.

mailchimp_cart_lines_bulk_delete

Delete a specific Mailchimp cart line item. Returns an empty 204 response on success. Required: store_id, cart_id, line_id.

list_all_mailchimp_click_detail_members

List Mailchimp subscribers who clicked on a specific link within a campaign. Returns: email_id, email_address, merge_fields, vip, clicks, campaign_id, url_id, list_id, list_is_active, contact_status, _links. Required: campaign_id, link_id.

list_all_mailchimp_click_detail_members_click_details

Get a specific Mailchimp subscriber who clicked a particular link in a campaign. Returns: email_id, email_address, merge_fields, vip, clicks, campaign_id, url_id, list_id, list_is_active, contact_status, _links. Required: campaign_id, link_id, subscriber_hash.

list_all_mailchimp_ecommerce_orders

List Mailchimp e-commerce orders for an account, optionally filtered by campaign, outreach, or customer. Returns each order with id, customer, store_id, order_total, currency_code, financial_status, lines, and shipping/billing addresses. Max 1000 records per page.

list_all_mailchimp_ecommerce_stores

List all ecommerce stores in the Mailchimp account. Returns: id, list_id, name, platform, domain, is_syncing, email_address, currency_code, money_format, primary_locale, timezone, phone, address, connected_site, automations, list_is_active, created_at, updated_at, _links. Max 1000 records per page.

get_single_mailchimp_ecommerce_store_by_id

Get a Mailchimp ecommerce store by id. Returns: id, list_id, platform, domain, is_syncing, email_address, currency_code, money_format, primary_locale, timezone, phone, address, connected_site, automations, list_is_active, created_at, updated_at, _links, x-title, name. Required: id.

create_a_mailchimp_ecommerce_store

Create a new ecommerce store in your Mailchimp account. Returns: id, list_id, name, platform, domain, is_syncing, email_address, currency_code, money_format, primary_locale, timezone, phone, address, connected_site, automations, list_is_active, created_at, updated_at, _links, title, status, detail, instance. Required: id, list_id, name, currency_code.

update_a_mailchimp_ecommerce_store_by_id

Update a Mailchimp ecommerce store by id. Returns: id, list_id, platform, domain, is_syncing, email_address, currency_code, money_format, primary_locale, timezone, phone, address, connected_site, automations, list_is_active, created_at, updated_at, _links, x-title, name. Required: id.

delete_a_mailchimp_ecommerce_store_by_id

Delete a Mailchimp ecommerce store by id. Deleting a store also deletes any associated subresources, including Customers, Orders, Products, and Carts. Returns an empty 204 response on success. Required: id.

list_all_mailchimp_promo_rule_promo_codes

List Mailchimp promo codes for a store's promo rule. Returns each promo code with id, code, redemption_url, usage_count, enabled, created_at_foreign, and updated_at_foreign. Required: store_id, promo_rule_id.

create_a_mailchimp_promo_rule_promo_code

Add a new promo code to a Mailchimp store's promo rule. Returns the created promo code with id, code, redemption_url, usage_count, enabled, created_at_foreign, and updated_at_foreign. Required: store_id, promo_rule_id, id, code, redemption_url.

get_single_mailchimp_promo_rule_promo_code_by_id

Get a single Mailchimp promo code by id. Returns the promo code with id, code, redemption_url, usage_count, enabled, created_at_foreign, and updated_at_foreign. Required: store_id, promo_rule_id, id.

mailchimp_promo_rule_promo_codes_bulk_update

Update a Mailchimp promo code for a store's promo rule. Returns the updated promo code with id, code, redemption_url, usage_count, enabled, created_at_foreign, and updated_at_foreign. Required: store_id, promo_rule_id, promo_code_id.

mailchimp_promo_rule_promo_codes_bulk_delete

Delete a Mailchimp promo code from a store. Returns an empty 204 response on success. Required: store_id, promo_rule_id, promo_code_id.

list_all_mailchimp_report_advices

List Mailchimp campaign feedback based on a campaign's statistics such as opens, clicks, unsubscribes, and bounces. Returns: type, message, _links. Required: campaign_id.

list_all_mailchimp_report_click_details

List click details for links in a Mailchimp campaign report. Returns: id, url, total_clicks, click_percentage, unique_clicks, unique_click_percentage, last_click, ab_split, campaign_id, _links. Required: campaign_id.

get_single_mailchimp_report_click_detail_by_id

Get click details for a specific link in a Mailchimp campaign report. Returns: id, url, total_clicks, click_percentage, unique_clicks, unique_click_percentage, last_click, ab_split, campaign_id, _links. Required: campaign_id, id.

list_all_mailchimp_report_domain_performances

List domain performance statistics for a Mailchimp campaign, showing the top 5 email domains by delivered emails. Returns: domain, emails_sent, bounces, opens, clicks, unsubs, delivered, emails_pct, bounces_pct, opens_pct, clicks_pct, unsubs_pct. Required: campaign_id.

list_all_mailchimp_report_ecommerce_product_activities

List Mailchimp campaign ecommerce product activity for a specific campaign. Returns: title, sku, image_url, total_revenue, total_purchased, currency_code, recommendation_total, recommendation_purchased. Required: campaign_id. Max 1000 records per page; results can be sorted by title, total_revenue, or total_purchased.

list_all_mailchimp_report_eepurls

List Mailchimp EepURL activity for a campaign, including social engagement and click metrics. Returns: twitter, clicks, referrers, eepurl, campaign_id, total_items, _links, x-title. Required: campaign_id.

list_all_mailchimp_report_email_activities

List member subscriber activity (opens, clicks, and bounces) for a specific Mailchimp campaign. Returns: campaign_id, list_id, list_is_active, email_id, email_address, activity, _links. Required: campaign_id. Member activity is limited to 1,000 open and 1,000 click activities per member per campaign.

list_all_mailchimp_report_email_activities_email_activity

Get a specific Mailchimp list member's email activity in a campaign, including opens, clicks, and bounces. Returns: campaign_id, list_id, list_is_active, email_id, email_address, activity, _links, fired_at, data. Required: campaign_id, subscriber_hash. Activity is limited to 1,000 open and 1,000 click events per member per campaign.

list_all_mailchimp_report_locations

List top open locations for a Mailchimp campaign by geographic region. Returns: country_code, region, region_name, opens, proxy_excluded_opens. Required: campaign_id. Max 1000 records per page.

list_all_mailchimp_report_open_details

List Mailchimp campaign open details showing which list members opened a campaign email. Returns: campaign_id, list_id, list_is_active, contact_status, email_id, email_address, merge_fields, vip, opens_count, proxy_excluded_opens_count, opens, _links. Required: campaign_id. Max 1000 records per page.

list_all_mailchimp_report_open_details_open_details

Get information about a specific Mailchimp campaign subscriber who opened a campaign. Returns: campaign_id, list_id, list_is_active, contact_status, email_id, email_address, merge_fields, vip, opens_count, proxy_excluded_opens_count, opens, _links. Required: campaign_id, subscriber_hash.

list_all_mailchimp_report_sent_tos

List Mailchimp campaign recipients who were sent a specific campaign. Returns: email_id, email_address, merge_fields, vip, status, open_count, last_open, absplit_group, gmt_offset, campaign_id, list_id, list_is_active, _links. Required: campaign_id.

list_all_mailchimp_report_sent_tos_sent_to

Get information about a specific Mailchimp campaign recipient by subscriber hash. Returns: email_id, email_address, merge_fields, vip, status, open_count, last_open, absplit_group, gmt_offset, campaign_id, list_id, list_is_active, _links. Required: campaign_id, subscriber_hash.

list_all_mailchimp_report_sub_reports

List child campaign reports for a specific Mailchimp parent campaign. Returns each sub-report with id, campaign_title, type, list_id, list_name, subject_line, emails_sent, bounces, opens, clicks, ecommerce, delivery_status, and additional engagement statistics. Required: campaign_id.

list_all_mailchimp_report_unsubscribeds

List members who unsubscribed from a specific Mailchimp campaign. Returns: email_id, email_address, merge_fields, vip, timestamp, reason, campaign_id, list_id, list_is_active, _links. Required: campaign_id. Max 1000 records per page.

list_all_mailchimp_report_unsubscribeds_unsubscribed

Get information about a specific Mailchimp list member who unsubscribed from a campaign. Returns: email_id, email_address, merge_fields, vip, timestamp, reason, campaign_id, list_id, list_is_active, _links, fired_at, data. Required: campaign_id, subscriber_hash.

list_all_mailchimp_store_carts

List carts for a Mailchimp store. Returns: id, customer, campaign_id, checkout_url, currency_code, order_total, tax_total, lines, created_at, updated_at, _links. Required: store_id.

get_single_mailchimp_store_cart_by_id

Get a specific Mailchimp store cart by id. Returns: id, customer, campaign_id, checkout_url, currency_code, order_total, tax_total, lines, created_at, updated_at, _links. Required: store_id, id.

create_a_mailchimp_store_cart

Create a new cart in a Mailchimp store. Returns: id, customer, campaign_id, checkout_url, currency_code, order_total, tax_total, lines, created_at, updated_at, _links, x-title. Required: store_id, id, currency_code, customer, order_total, lines.

mailchimp_store_carts_bulk_update

Update a specific Mailchimp store cart. Returns: id, customer, campaign_id, checkout_url, currency_code, order_total, tax_total, lines, created_at, updated_at, _links. Required: store_id, cart_id.

mailchimp_store_carts_bulk_delete

Delete a Mailchimp store cart by cart_id. Returns an empty 204 response on success. Required: store_id, cart_id.

list_all_mailchimp_store_customers

List Mailchimp store customers. Returns: id, email_address, sms_phone_number, opt_in_status, company, first_name, last_name, orders_count, total_spent, address, created_at, updated_at, _links. Required: store_id. Max 1000 records per page.

get_single_mailchimp_store_customer_by_id

Get a single Mailchimp store customer by id. Returns: id, email_address, sms_phone_number, opt_in_status, company, first_name, last_name, orders_count, total_spent, address, created_at, updated_at, _links. Required: store_id, id.

create_a_mailchimp_store_customer

Add a new customer to a Mailchimp store. Returns: id, email_address, sms_phone_number, opt_in_status, company, first_name, last_name, orders_count, total_spent, address, created_at, updated_at, _links, x-title. Required: store_id, id, opt_in_status. Customer id limited to 50 characters.

mailchimp_store_customers_bulk_update

Add or update (upsert) a Mailchimp store customer by customer_id. Returns: id, email_address, sms_phone_number, opt_in_status, company, first_name, last_name, orders_count, total_spent, address, created_at, updated_at, _links. Required: store_id, customer_id, id.

mailchimp_store_customers_partial_update

Update a Mailchimp store customer by id. Returns: id, email_address, sms_phone_number, opt_in_status, company, first_name, last_name, orders_count, total_spent, address, created_at, updated_at, _links. Required: store_id, id.

mailchimp_store_customers_bulk_delete

Delete a Mailchimp ecommerce store customer from a store. Returns an empty 204 response on success. Required: store_id, customer_id.

list_all_mailchimp_store_promo_rules

List Mailchimp promo rules for a store. Returns: id, title, description, starts_at, ends_at, amount, type, target, enabled, created_at_foreign, updated_at_foreign, _links. Required: store_id. Max 1000 records per page.

get_single_mailchimp_store_promo_rule_by_id

Get a single Mailchimp promo rule by id. Returns: id, title, description, starts_at, ends_at, amount, type, target, enabled, created_at_foreign, updated_at_foreign, _links. Required: store_id, id.

create_a_mailchimp_store_promo_rule

Create a new Mailchimp promo rule for a store. Returns: id, title, description, starts_at, ends_at, amount, type, target, enabled, created_at_foreign, updated_at_foreign, _links, x-title. Required: store_id, id, description, amount, type, target.

mailchimp_store_promo_rules_bulk_update

Update a Mailchimp promo rule for a store. Returns: id, title, description, starts_at, ends_at, amount, type, target, enabled, created_at_foreign, updated_at_foreign, _links. Required: store_id, promo_rule_id.

mailchimp_store_promo_rules_bulk_delete

Delete a Mailchimp promo rule from a store. Returns an empty 204 response on success. Required: store_id, promo_rule_id.

list_all_mailchimp_template_default_contents

Get the editable sections and their default content for a Mailchimp template. Returns: sections, _links, x-title. Required: template_id.

list_all_mailchimp_facebook_ad_ecommerce_product_activities

List Mailchimp Facebook Ads ecommerce product activity for a specific outreach. Returns: title, sku, image_url, total_revenue, total_purchased, currency_code, recommendation_total, recommendation_purchased. Required: outreach_id. Max 1000 records per page.

list_all_mailchimp_facebook_ads

List Facebook ad out reaches in Mailchimp. Returns: id, web_id, name, type, status, show_report, create_time, start_time, updated_at, canceled_at, published_time, has_segment, report_summary, recipients, email_source_name, paused_at, end_time, needs_attention, was_canceled_by_facebook, thumbnail, is_connected, has_audience, has_content, channel, feedback, site, audience, budget, content, _links.…

get_single_mailchimp_facebook_ad_by_id

Get details of a specific Facebook ad outreach in Mailchimp by id. Returns: id, web_id, type, status, show_report, create_time, start_time, updated_at, canceled_at, published_time, has_segment, report_summary, recipients, email_source_name, paused_at, end_time, needs_attention, was_canceled_by_facebook, thumbnail, is_connected, has_audience, has_content, channel, feedback, site, audience, budget,…

list_all_mailchimp_order_lines

List order line items for a Mailchimp ecommerce order. Returns: id, product_id, product_title, product_variant_id, product_variant_title, image_url, quantity, price, discount, _links. Required: store_id, order_id. Max 1000 records per page.

get_single_mailchimp_order_line_by_id

Get a specific Mailchimp order line item by id. Returns: id, product_id, product_title, product_variant_id, product_variant_title, image_url, quantity, price, discount, _links. Required: store_id, order_id, id.

create_a_mailchimp_order_line

Add a new line item to an existing Mailchimp ecommerce order. Returns: id, product_id, product_title, product_variant_id, product_variant_title, image_url, quantity, price, discount, _links, x-title. Required: store_id, order_id, id, product_id, product_variant_id, quantity, price.

mailchimp_order_lines_bulk_update

Update a specific Mailchimp order line item. Returns: id, product_id, product_title, product_variant_id, product_variant_title, image_url, quantity, price, discount, _links. Required: store_id, order_id, line_id.

mailchimp_order_lines_bulk_delete

Delete a specific Mailchimp order line item. Returns an empty 204 response on success. Required: store_id, order_id, line_id.

list_all_mailchimp_pings

Ping the Mailchimp Marketing API as a health check that won't return any account-specific information. Returns: health_status!"). No parameters required.

list_all_mailchimp_product_images

List product images for a specific Mailchimp product in a store. Returns: id, url, variant_ids, _links. Required: store_id, product_id.

get_single_mailchimp_product_image_by_id

Get information about a specific Mailchimp product image. Returns: id, url, variant_ids, _links. Required: store_id, product_id, id.

create_a_mailchimp_product_image

Add a new image to a Mailchimp product. Returns: id, url, variant_ids, _links, x-title. Required: store_id, product_id, id, url.

mailchimp_product_images_bulk_update

Update a Mailchimp product image. Returns: id, url, variant_ids, _links. Required: store_id, product_id, image_id.

mailchimp_product_images_bulk_delete

Delete a Mailchimp product image. Returns an empty 204 response on success. Required: store_id, product_id, image_id.

list_all_mailchimp_product_variants

List Mailchimp product variants for a specific product in a store. Returns: id, title, url, sku, price, inventory_quantity, image_url, backorders, visibility, created_at, updated_at, _links. Required: store_id, product_id.

get_single_mailchimp_product_variant_by_id

Get a single Mailchimp product variant by id. Returns: id, title, url, sku, price, inventory_quantity, image_url, backorders, visibility, created_at, updated_at, _links. Required: store_id, product_id, id.

create_a_mailchimp_product_variant

Add a new Mailchimp product variant to a product. Returns: id, title, url, sku, price, inventory_quantity, image_url, backorders, visibility, created_at, updated_at, _links, x-title. Required: store_id, product_id, id.

mailchimp_product_variants_bulk_update

Add or update (upsert) a Mailchimp product variant by variant_id. Returns: id, title, url, sku, price, inventory_quantity, image_url, backorders, visibility, created_at, updated_at, _links. Required: store_id, product_id, variant_id, id.

mailchimp_product_variants_partial_update

Partially update a Mailchimp product variant by id. Returns: id, title, url, sku, price, inventory_quantity, image_url, backorders, visibility, created_at, updated_at, _links. Required: store_id, product_id, id.

mailchimp_product_variants_bulk_delete

Delete a Mailchimp e-commerce product variant from a specific store and product. Returns an empty 204 response on success. Required: store_id, product_id, variant_id.

list_all_mailchimp_reporting_facebook_ads

List Facebook ad reports in Mailchimp. Returns: id, web_id, name, type, status, show_report, create_time, start_time, updated_at, canceled_at, published_time, has_segment, report_summary, recipients, email_source_name, paused_at, end_time, needs_attention, was_canceled_by_facebook, thumbnail, channel, audience, budget, audience_activity, _links. Sortable by created_at, updated_at, or end_time.

get_single_mailchimp_reporting_facebook_ad_by_id

Get a single Mailchimp Facebook ad report by id. Returns: id, web_id, type, status, show_report, create_time, start_time, updated_at, canceled_at, published_time, has_segment, report_summary, recipients, email_source_name, paused_at, end_time, needs_attention, was_canceled_by_facebook, thumbnail, channel, audience, budget, audience_activity, _links, x-title, name. Required: id.

list_all_mailchimp_reporting_landing_pages

List Mailchimp landing page reports with engagement and ecommerce metrics. Returns: id, name, title, url, published_at, unpublished_at, status, list_id, visits, unique_visits, subscribes, clicks, conversion_rate, timeseries, ecommerce, web_id, list_name, signup_tags, _links. Max 1000 records per page.

get_single_mailchimp_reporting_landing_page_by_id

Get a Mailchimp landing page report by id. Returns: id, title, url, published_at, unpublished_at, status, list_id, visits, unique_visits, subscribes, clicks, conversion_rate, timeseries, ecommerce, web_id, list_name, signup_tags, _links, x-title. Required: id.

list_all_mailchimp_search_campaigns

Search Mailchimp campaigns by query terms. Returns matching results, each containing a campaign object with id, web_id, type, status, create_time, send_time, and emails_sent. Required: query.

list_all_mailchimp_sms_campaign_contents

Get the content for a Mailchimp SMS campaign. Returns: message_body, estimated_segments, merge_fields, media, source, properties, _links, x-title. Required: sms_campaign_id.

mailchimp_sms_campaign_contents_bulk_update

Set the content for a Mailchimp SMS campaign, including the message body and optional media attachments. Returns: message_body, estimated_segments, merge_fields, media, source, properties, _links, fired_at, data. Required: sms_campaign_id, message_body.

list_all_mailchimp_sms_campaigns

List all Mailchimp SMS campaigns in an account. Returns: id, web_id, name, status, channel, list_id, recipient_count, create_time, send_time, updated_at, expire_time, is_send_now, folder_id, segments, excluded_segments, _links.

get_single_mailchimp_sms_campaign_by_id

Get a specific Mailchimp SMS campaign by id. Returns the campaign object including id, web_id, name, status, channel, list_id, recipient_count, create_time, send_time, updated_at, expire_time, is_send_now, folder_id, segments, excluded_segments, and _links. Required: id.

create_a_mailchimp_sms_campaign

Create a new Mailchimp SMS campaign. Returns the created campaign object including id, web_id, name, status, channel, list_id, recipient_count, create_time, send_time, updated_at, expire_time, is_send_now, folder_id, segments, excluded_segments, and _links. Required: name.

update_a_mailchimp_sms_campaign_by_id

Update settings for a specific Mailchimp SMS campaign by id. Returns the updated campaign object including id, web_id, name, status, channel, list_id, recipient_count, create_time, send_time, updated_at, expire_time, is_send_now, folder_id, segments, excluded_segments, and _links. Required: id.

delete_a_mailchimp_sms_campaign_by_id

Delete a Mailchimp SMS campaign by id. Returns an empty 204 response on success. Required: id.

mailchimp_sms_campaigns_send

Send a Mailchimp SMS campaign immediately. Returns an empty 204 response on success. Required: sms_campaign_id.

mailchimp_sms_campaigns_schedule

Schedule a Mailchimp SMS campaign to send at a specific UTC date and time. Returns an empty 204 response on success. Required: sms_campaign_id, schedule_time.

mailchimp_sms_campaigns_cancel_send

Cancel a scheduled or sending Mailchimp SMS campaign. Returns an empty 204 response on success. Required: sms_campaign_id.

list_all_mailchimp_store_orders

List Mailchimp store orders, optionally filtered by customer, campaign, or outreach. Returns each order with id, customer, currency_code, order_total, lines, financial_status, shipping_address, and billing_address. Required: store_id.

get_single_mailchimp_store_order_by_id

Get a single Mailchimp store order by id. Returns the full order object including id, customer, currency_code, order_total, lines, financial_status, shipping_address, and billing_address. Required: store_id, id.

create_a_mailchimp_store_order

Create a new order in a Mailchimp store. Returns the created order with id, customer, currency_code, order_total, lines, and billing/shipping addresses. Required: store_id, id, customer, currency_code, order_total, lines. Passing cancelled_at_foreign will cancel the order being created.

mailchimp_store_orders_bulk_update

Add or update a Mailchimp e-commerce store order. Returns: id, customer, store_id, campaign_id, cart_id, landing_site, financial_status, fulfillment_status, currency_code, order_total, order_url, discount_total, tax_total, shipping_total, tracking_code, processed_at_foreign, cancelled_at_foreign, updated_at_foreign, shipping_address, billing_address, promos, lines, outreach, tracking_number,…

mailchimp_store_orders_partial_update

Update a specific Mailchimp ecommerce order in a store. Returns the updated order object including its id, customer, currency_code, order_total, financial_status, fulfillment_status, and lines. Required: store_id, id.

mailchimp_store_orders_bulk_delete

Delete an order from a Mailchimp ecommerce store. Returns an empty 204 response on success. Required: store_id, order_id.

list_all_mailchimp_store_products

List Mailchimp e-commerce store products. Returns: id, currency_code, title, handle, url, description, type, vendor, image_url, variants, images, published_at_foreign, _links. Required: store_id.

get_single_mailchimp_store_product_by_id

Get a single Mailchimp e-commerce store product by id. Returns: id, currency_code, title, handle, url, description, type, vendor, image_url, variants, images, published_at_foreign, _links. Required: store_id, id.

create_a_mailchimp_store_product

Add a new product to a Mailchimp e-commerce store. Returns: id, currency_code, title, handle, url, description, type, vendor, image_url, variants, images, published_at_foreign, _links, x-title. Required: store_id, id, title, variants.

mailchimp_store_products_bulk_update

Create or update (upsert) a Mailchimp e-commerce store product. Returns: id, currency_code, title, handle, url, description, type, vendor, image_url, variants, images, published_at_foreign, _links. Required: store_id, product_id, id.

mailchimp_store_products_partial_update

Partially update a Mailchimp e-commerce store product. Returns: id, currency_code, title, handle, url, description, type, vendor, image_url, variants, images, published_at_foreign, _links. Required: store_id, id.

mailchimp_store_products_bulk_delete

Delete a product from a Mailchimp ecommerce store. Returns an empty 204 response on success. Required: store_id, product_id.

list_all_mailchimp_question_answers

List answers submitted for a specific Mailchimp survey question. Returns: id, value, response_id, submitted_at, contact, is_new_contact. Required: survey_id, question_id.

get_single_mailchimp_reporting_survey_by_id

Get a Mailchimp survey report by id. Returns: id, web_id, list_id, list_name, title, url, status, published_at, created_at, updated_at, total_responses, x-title. Required: id.

list_all_mailchimp_reporting_surveys

List Mailchimp survey reports. Returns each survey report with id, title, status, total_responses, list_id, list_name, url, web_id, published_at, created_at, and updated_at. Max 1000 records per page.

get_single_mailchimp_survey_question_by_id

Get a single Mailchimp survey question report by id. Returns the question report including its id, survey_id, query, type, total_responses, is_required, options, and contact_counts. Required: survey_id, id.

list_all_mailchimp_survey_questions

List Mailchimp survey question reports for a survey. Returns each question report with id, survey_id, query, type, total_responses, is_required, options, and contact_counts. Required: survey_id.

get_single_mailchimp_survey_response_by_id

Get a single Mailchimp survey response by id. Returns: response_id, submitted_at, contact, is_new_contact, results, fired_at, data. Required: survey_id, id.

list_all_mailchimp_survey_responses

List Mailchimp survey responses for a survey. Returns: response_id, submitted_at, contact, is_new_contact. Required: survey_id.

list_all_mailchimp_verified_domains

List verified domains on the Mailchimp account. Returns: domain, verified, authenticated, verification_email, verification_sent, status, is_free_email_provider.

create_a_mailchimp_verified_domain

Add a domain to the Mailchimp account for verification. Returns: domain, verified, authenticated, verification_email, verification_sent, status, is_free_email_provider. Required: verification_email.

mailchimp_verified_domains_bulk_delete

Delete a verified domain from the Mailchimp account. Returns an empty 204 response on success. Required: domain_name.

mailchimp_verified_domains_verify

Verify a domain for sending in Mailchimp by submitting the verification challenge code. Returns: domain, verified, authenticated, verification_email, verification_sent, status, is_free_email_provider, x-title. Required: domain_name, code.

list_all_mailchimp_verified_domains_verified_domains

Get details for a single verified domain in Mailchimp by domain name. Returns: domain, verified, authenticated, verification_email, verification_sent, status, is_free_email_provider. Required: domain_name.