Skip to content
Changelog

Report a bug

Mailchimp integration: operations for AI agents

Mailchimp connects to Type.com as an integration. This page lists the 307 operations documented for Claude and Codex in Type.com: 154 read, 97 write, 56 destructive.

About Mailchimp

Mailchimp is an email marketing and automation platform providing campaign templates, audience segmentation, and performance analytics to drive engagement and conversions

Categories: Marketing & Social

How to connect Mailchimp to Type.com

Access
Organization connection: one shared account for the workspace.

To add the connection, follow the steps in Space connections.

Documented operations

307 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

307 operations listed.

Root

  • Read

    List api root resources

    Get links to all other resources available in the API.

    GET /

Activity Feed

  • Read

    Get latest chimp chatter

    Return the Chimp Chatter for this account ordered by most recent.

    GET /activity-feed/chimp-chatter

Account Exports

  • Read

    List account exports

    Get a list of account exports for a given account.

    GET /account-exports

  • Write

    Add export

    Create a new account export in your Mailchimp account.

    POST /account-exports

Account Export

  • Read

    Get account export info

    Get information about a specific account export.

    GET /account-exports/{export_id}

Contacts

  • Read

    Get a list of audiences

    Get information about all audiences in the account.

    GET /audiences

  • Read

    Get audience info

    Get information about a specific audience.

    GET /audiences/{audience_id}

  • Write

    Forget Contact

    Forgets a Contact.

    POST /audiences/{audience_id}/contacts/{contact_id}/actions/forget

  • Destructive

    Archive Contact

    Archives a Contact.

    POST /audiences/{audience_id}/contacts/{contact_id}/actions/archive

Audiences

  • Read

    Get Contacts

    Get a list of omni-channel contacts for a given audience.

    GET /audiences/{audience_id}/contacts

  • Read

    Get Contact

    Retrieve a specific omni-channel contact in an audience.

    GET /audiences/{audience_id}/contacts/{contact_id}

  • Write

    Add Contact

    Create a new omni-channel contact for an audience.

    POST /audiences/{audience_id}/contacts

  • Write

    Update Contact

    Update an existing omni-channel contact.

    PATCH /audiences/{audience_id}/contacts/{contact_id}

Segments

  • Read

    List Segments

    Get the segments of a list. The response contains only metadata. It includes advanced segments and read-only segments that other Mailchimp tools made, for example Google Analytics segments and segments from the AI segment builder. The `read_only` property of each segment shows if you can update it.

    GET /segments

  • Read

    Get Segment

    Get the metadata of a segment. If the segment is not read-only, the response also contains its definition. Read-only segments do not have a definition.

    GET /segments/{segment_id}

  • Read

    Get Segment Snapshot

    Get the status of a segment snapshot.

    GET /segments/{segment_id}/snapshots/{snapshot_id}

  • Read

    Get Snapshot Member Contact IDs

    Get the contact IDs of the members in a segment snapshot, one page at a time.

    GET /segments/{segment_id}/snapshots/{snapshot_id}/members

  • Read

    Get Segment Member Count

    Get the current number of members in a segment. If there is no recent count, the API calculates a new count. The request waits until the count is complete.

    GET /segments/{segment_id}/count

  • Write

    Add Segment

    Create an advanced segment from a segment definition. The account's plan must include advanced segmentation. If it does not, the API returns a 403 error.

    POST /segments

  • Write

    Update Segment

    Update the name, the definition, or both of an advanced segment. You cannot update a read-only segment. The account's plan must include advanced segmentation. If it does not, the API returns a 403 error. You cannot change `list_id` or `read_only`. If a request includes one of them, the API returns a 400 error.

    PATCH /segments/{segment_id}

  • Write

    Snapshot a Segment

    Start a snapshot of the members of a segment. The API makes the snapshot in the background. Use Get Segment Snapshot to see its status. To snapshot an advanced segment, the account's plan must include advanced segmentation. If it does not, the API returns a 403 error. Other types of segment do not need advanced segmentation.

    POST /segments/{segment_id}/snapshots

  • Destructive

    Delete Segment

    Delete an advanced segment. You cannot delete a read-only segment.

    DELETE /segments/{segment_id}

Authorized Apps

  • Read

    List authorized apps

    Get a list of an account's registered, connected applications.

    GET /authorized-apps

  • Read

    Get authorized app info

    Get information about a specific authorized application.

    GET /authorized-apps/{app_id}

Automations

  • Read

    List automations

    Get a summary of an account's classic automations.

    GET /automations

  • Read

    Get automation info

    Get a summary of an individual classic automation workflow's settings and content. The `trigger_settings` object returns information for the first email in the workflow.

    GET /automations/{workflow_id}

  • Read

    List automated emails

    Get a summary of the emails in a classic automation workflow.

    GET /automations/{workflow_id}/emails

  • Read

    Get workflow email info

    Get information about an individual classic automation workflow email.

    GET /automations/{workflow_id}/emails/{workflow_email_id}

  • Read

    List automated email subscribers

    Get information about a classic automation email queue.

    GET /automations/{workflow_id}/emails/{workflow_email_id}/queue

  • Read

    Get automated email subscriber

    Get information about a specific subscriber in a classic automation email queue.

    GET /automations/{workflow_id}/emails/{workflow_email_id}/queue/{subscriber_hash}

  • Read

    List subscribers removed from workflow

    Get information about subscribers who were removed from a classic automation workflow.

    GET /automations/{workflow_id}/removed-subscribers

  • Read

    Get subscriber removed from workflow

    Get information about a specific subscriber who was removed from a classic automation workflow.

    GET /automations/{workflow_id}/removed-subscribers/{subscriber_hash}

  • Write

    Add automation

    Create a new classic automation in your Mailchimp account.

    POST /automations

  • Write

    Pause automation emails

    Pause all emails in a specific classic automation workflow.

    POST /automations/{workflow_id}/actions/pause-all-emails

  • Write

    Start automation emails

    Start all emails in a classic automation workflow.

    POST /automations/{workflow_id}/actions/start-all-emails

  • Write

    Update workflow email

    Update settings for a classic automation workflow email. Only works with workflows of type: abandonedBrowse, abandonedCart, emailFollowup, or singleWelcome.

    PATCH /automations/{workflow_id}/emails/{workflow_email_id}

  • Write

    Add subscriber to workflow email

    Manually add a subscriber to a workflow, bypassing the default trigger settings. You can also use this endpoint to trigger a series of automated emails in an API 3.0 workflow type.

    POST /automations/{workflow_id}/emails/{workflow_email_id}/queue

  • Write

    Pause automated email

    Pause an automated email.

    POST /automations/{workflow_id}/emails/{workflow_email_id}/actions/pause

  • Write

    Start automated email

    Start an automated email.

    POST /automations/{workflow_id}/emails/{workflow_email_id}/actions/start

  • Destructive

    Archive automation

    Archiving will permanently end your automation and keep the report data. You’ll be able to replicate your archived automation, but you can’t restart it.

    POST /automations/{workflow_id}/actions/archive

  • Destructive

    Delete workflow email

    Removes an individual classic automation workflow email. Emails from certain workflow types, including the Abandoned Cart Email (abandonedCart) and Product Retargeting Email (abandonedBrowse) Workflows, cannot be deleted.

    DELETE /automations/{workflow_id}/emails/{workflow_email_id}

  • Destructive

    Remove subscriber from workflow

    Remove a subscriber from a specific classic automation workflow. You can remove a subscriber at any point in an automation workflow, regardless of how many emails they've been sent from that workflow. Once they're removed, they can never be added back to the same workflow.

    POST /automations/{workflow_id}/removed-subscribers

Batches

  • Read

    List batch requests

    Get a summary of batch requests that have been made.

    GET /batches

  • Read

    Get batch operation status

    Get the status of a batch request.

    GET /batches/{batch_id}

  • Destructive

    Start batch operation

    Begin processing a batch operations request.

    POST /batches

  • Destructive

    Delete batch request

    Stops a batch request from running. Since only one batch request is run at a time, this can be used to cancel a long running request. The results of any completed operations will not be available after this call.

    DELETE /batches/{batch_id}

Batch Webhooks

  • Read

    List batch webhooks

    Get all webhooks that have been configured for batches.

    GET /batch-webhooks

  • Read

    Get batch webhook info

    Get information about a specific batch webhook.

    GET /batch-webhooks/{batch_webhook_id}

  • Write

    Add batch webhook

    Configure a webhook that will fire whenever any batch request completes processing. You may only have a maximum of 20 batch webhooks.

    POST /batch-webhooks

  • Write

    Update batch webhook

    Update a webhook that will fire whenever any batch request completes processing.

    PATCH /batch-webhooks/{batch_webhook_id}

  • Destructive

    Delete batch webhook

    Remove a batch webhook. Webhooks will no longer be sent to the given URL.

    DELETE /batch-webhooks/{batch_webhook_id}

Template Folders

  • Read

    List template folders

    Get all folders used to organize templates.

    GET /template-folders

  • Read

    Get template folder

    Get information about a specific folder used to organize templates.

    GET /template-folders/{folder_id}

  • Write

    Add template folder

    Create a new template folder.

    POST /template-folders

  • Write

    Update template folder

    Update a specific folder used to organize templates.

    PATCH /template-folders/{folder_id}

  • Destructive

    Delete template folder

    Delete a specific template folder, and mark all the templates in the folder as 'unfiled'.

    DELETE /template-folders/{folder_id}

Campaign Folders

  • Read

    List campaign folders

    Get all folders used to organize campaigns.

    GET /campaign-folders

  • Read

    Get campaign folder

    Get information about a specific folder used to organize campaigns.

    GET /campaign-folders/{folder_id}

  • Write

    Add campaign folder

    Create a new campaign folder.

    POST /campaign-folders

  • Write

    Update campaign folder

    Update a specific folder used to organize campaigns.

    PATCH /campaign-folders/{folder_id}

  • Destructive

    Delete campaign folder

    Delete a specific campaign folder, and mark all the campaigns in the folder as 'unfiled'.

    DELETE /campaign-folders/{folder_id}

Campaigns

  • Read

    List campaigns

    Get all campaigns in an account.

    GET /campaigns

  • Read

    Get campaign info

    Get information about a specific campaign.

    GET /campaigns/{campaign_id}

  • Read

    Get campaign content

    Get the the HTML and plain-text content for a campaign.

    GET /campaigns/{campaign_id}/content

  • Read

    List campaign feedback

    Get team feedback while you're working together on a Mailchimp campaign.

    GET /campaigns/{campaign_id}/feedback

  • Read

    Get campaign feedback message

    Get a specific feedback message from a campaign.

    GET /campaigns/{campaign_id}/feedback/{feedback_id}

  • Read

    Get campaign send checklist

    Review the send checklist for a campaign, and resolve any issues before sending.

    GET /campaigns/{campaign_id}/send-checklist

  • Write

    Add campaign

    Create a new Mailchimp campaign.

    POST /campaigns

  • Write

    Update campaign settings

    Update some or all of the settings for a specific campaign.

    PATCH /campaigns/{campaign_id}

  • Write

    Replicate campaign

    Replicate a campaign in saved or send status.

    POST /campaigns/{campaign_id}/actions/replicate

  • Write

    Send campaign

    Send a Mailchimp campaign. For RSS Campaigns, the campaign will send according to its schedule. All other campaigns will send immediately.

    POST /campaigns/{campaign_id}/actions/send

  • Write

    Schedule campaign

    Schedule a campaign for delivery. If you're using Multivariate Campaigns to test send times or sending RSS Campaigns, use the send action instead.

    POST /campaigns/{campaign_id}/actions/schedule

  • Write

    Unschedule campaign

    Unschedule a scheduled campaign that hasn't started sending.

    POST /campaigns/{campaign_id}/actions/unschedule

  • Write

    Send test email

    Send a test email.

    POST /campaigns/{campaign_id}/actions/test

  • Write

    Pause rss campaign

    Pause an RSS-Driven campaign.

    POST /campaigns/{campaign_id}/actions/pause

  • Write

    Resume rss campaign

    Resume an RSS-Driven campaign.

    POST /campaigns/{campaign_id}/actions/resume

  • Write

    Resend campaign

    Remove the guesswork for resending a campaign to certain segments. You can use this endpoint as a shortcut to replicate a campaign and resend it to common segments, such as those who didn't open the campaign, or any new subscribers since it was sent.

    POST /campaigns/{campaign_id}/actions/create-resend

  • Write

    Add campaign feedback

    Add feedback on a specific campaign.

    POST /campaigns/{campaign_id}/feedback

  • Write

    Update campaign feedback message

    Update a specific feedback message for a campaign.

    PATCH /campaigns/{campaign_id}/feedback/{feedback_id}

  • Destructive

    Delete campaign

    Remove a campaign from your Mailchimp account.

    DELETE /campaigns/{campaign_id}

  • Destructive

    Cancel campaign

    Cancel a Regular or Plain-Text Campaign after you send, before all of your recipients receive it. This feature is included with Mailchimp Pro.

    POST /campaigns/{campaign_id}/actions/cancel-send

  • Destructive

    Set campaign content

    Set the content for a campaign.

    PUT /campaigns/{campaign_id}/content

  • Destructive

    Delete campaign feedback message

    Remove a specific feedback message for a campaign.

    DELETE /campaigns/{campaign_id}/feedback/{feedback_id}

Connected Sites

  • Read

    List connected sites

    Get all connected sites in an account.

    GET /connected-sites

  • Read

    Get connected site

    Get information about a specific connected site.

    GET /connected-sites/{connected_site_id}

  • Write

    Add connected site

    Create a new Mailchimp connected site.

    POST /connected-sites

  • Write

    Verify connected site script

    Verify that the connected sites script has been installed, either via the script URL or fragment.

    POST /connected-sites/{connected_site_id}/actions/verify-script-installation

  • Write

    Enable pixel for connected site

    Enable the Mailchimp tracking pixel for a connected site.

    POST /connected-sites/{connected_site_id}/actions/enable-pixel

  • Write

    Disable pixel for connected site

    Disable the Mailchimp tracking pixel for a connected site.

    POST /connected-sites/{connected_site_id}/actions/disable-pixel

  • Destructive

    Delete connected site

    Remove a connected site from your Mailchimp account.

    DELETE /connected-sites/{connected_site_id}

conversations

  • Read

    List conversations (deprecated)

    Get a list of conversations for the account. Conversations has been deprecated in favor of Inbox and these endpoints don't include Inbox data. Past Conversations are still available via this endpoint, but new campaign replies and other Inbox messages aren’t available using this endpoint.

    GET /conversations

  • Read

    Get conversation (deprecated)

    Get details about an individual conversation. Conversations has been deprecated in favor of Inbox and these endpoints don't include Inbox data. Past Conversations are still available via this endpoint, but new campaign replies and other Inbox messages aren’t available using this endpoint.

    GET /conversations/{conversation_id}

  • Read

    List messages (deprecated)

    Get messages from a specific conversation. Conversations has been deprecated in favor of Inbox and these endpoints don't include Inbox data. Past Conversations are still available via this endpoint, but new campaign replies and other Inbox messages aren’t available using this endpoint.

    GET /conversations/{conversation_id}/messages

  • Read

    Get message (deprecated)

    Get an individual message in a conversation. Conversations has been deprecated in favor of Inbox and these endpoints don't include Inbox data. Past Conversations are still available via this endpoint, but new campaign replies and other Inbox messages aren’t available using this endpoint.

    GET /conversations/{conversation_id}/messages/{message_id}

Customer Journeys

  • Write

    Customer Journeys API trigger for a contact

    A step trigger in an Automation flow. To use it, create a starting point or step from the Automation flow builder in the app using the Customer Journey API condition. We’ll provide a url during the process that includes the {journey_id} and {step_id}. You’ll then be able to use this endpoint to trigger the condition for the posted contact.

    POST /customer-journeys/journeys/{journey_id}/steps/{step_id}/actions/trigger

File Manager

  • Read

    List stored files

    Get a list of available images and files stored in the File Manager for the account.

    GET /file-manager/files

  • Read

    Get file

    Get information about a specific file in the File Manager.

    GET /file-manager/files/{file_id}

  • Read

    List folders

    Get a list of all folders in the File Manager.

    GET /file-manager/folders

  • Read

    Get folder

    Get information about a specific folder in the File Manager.

    GET /file-manager/folders/{folder_id}

  • Read

    List stored files

    Get a list of available images and files stored in this folder.

    GET /file-manager/folders/{folder_id}/files

  • Write

    Add file

    Upload a new image or file to the File Manager.

    POST /file-manager/files

  • Write

    Update file

    Update a file in the File Manager.

    PATCH /file-manager/files/{file_id}

  • Write

    Add folder

    Create a new folder in the File Manager.

    POST /file-manager/folders

  • Write

    Update folder

    Update a specific File Manager folder.

    PATCH /file-manager/folders/{folder_id}

  • Destructive

    Delete file

    Remove a specific file from the File Manager.

    DELETE /file-manager/files/{file_id}

  • Destructive

    Delete folder

    Delete a specific folder in the File Manager.

    DELETE /file-manager/folders/{folder_id}

Lists

  • Read

    Get lists info

    Get information about all lists in the account.

    GET /lists

  • Read

    Get list info

    Get information about a specific list in your Mailchimp account. Results include list members who have signed up but haven't confirmed their subscription yet and unsubscribed or cleaned.

    GET /lists/{list_id}

  • Read

    List abuse reports

    Get all abuse reports for a specific list.

    GET /lists/{list_id}/abuse-reports

  • Read

    Get abuse report

    Get details about a specific abuse report.

    GET /lists/{list_id}/abuse-reports/{report_id}

  • Read

    List recent activity

    Get up to the previous 180 days of daily detailed aggregated activity stats for a list, not including Automation activity.

    GET /lists/{list_id}/activity

  • Read

    List top email clients

    Get a list of the top email clients based on user-agent strings.

    GET /lists/{list_id}/clients

  • Read

    List growth history data

    Get a month-by-month summary of a specific list's growth activity.

    GET /lists/{list_id}/growth-history

  • Read

    Get growth history by month

    Get a summary of a specific list's growth activity for a specific month and year.

    GET /lists/{list_id}/growth-history/{month}

  • Read

    List interest categories

    Get information about a list's interest categories.

    GET /lists/{list_id}/interest-categories

  • Read

    Get interest category info

    Get information about a specific interest category.

    GET /lists/{list_id}/interest-categories/{interest_category_id}

  • Read

    List interests in category

    Get a list of this category's interests.

    GET /lists/{list_id}/interest-categories/{interest_category_id}/interests

  • Read

    Get interest in category

    Get interests or 'group names' for a specific category.

    GET /lists/{list_id}/interest-categories/{interest_category_id}/interests/{interest_id}

  • Read

    List segments

    Get information about all available segments for a specific list.

    GET /lists/{list_id}/segments

  • Read

    Get segment info

    Get information about a specific segment.

    GET /lists/{list_id}/segments/{segment_id}

  • Read

    List members in segment

    Get information about members in a saved segment.

    GET /lists/{list_id}/segments/{segment_id}/members

  • Read

    Search for tags on a list by name.

    Search for tags on a list by name. If no name is provided, will return all tags on the list.

    GET /lists/{list_id}/tag-search

  • Read

    List members info

    Get information about members in a specific Mailchimp list.

    GET /lists/{list_id}/members

  • Read

    Get member info

    Get information about a specific list member, including a currently subscribed, unsubscribed, or bounced member.

    GET /lists/{list_id}/members/{subscriber_hash}

  • Read

    View recent activity 50

    Get the last 50 events of a member's activity on a specific list, including opens, clicks, and unsubscribes.

    GET /lists/{list_id}/members/{subscriber_hash}/activity

  • Read

    View recent activity

    Get a member's activity on a specific list, including opens, clicks, and unsubscribes.

    GET /lists/{list_id}/members/{subscriber_hash}/activity-feed

  • Read

    List member tags

    Get the tags on a list member.

    GET /lists/{list_id}/members/{subscriber_hash}/tags

  • Read

    List member events

    Get events for a contact.

    GET /lists/{list_id}/members/{subscriber_hash}/events

  • Read

    List member goal events

    Get the last 50 Goal events for a member on a specific list.

    GET /lists/{list_id}/members/{subscriber_hash}/goals

  • Read

    List recent member notes

    Get recent notes for a specific list member.

    GET /lists/{list_id}/members/{subscriber_hash}/notes

  • Read

    Get member note

    Get a specific note for a specific list member.

    GET /lists/{list_id}/members/{subscriber_hash}/notes/{note_id}

  • Read

    List merge fields

    Get a list of all merge fields for an audience.

    GET /lists/{list_id}/merge-fields

  • Read

    Get merge field

    Get information about a specific merge field.

    GET /lists/{list_id}/merge-fields/{merge_id}

  • Read

    List webhooks

    Get information about all webhooks for a specific list.

    GET /lists/{list_id}/webhooks

  • Read

    Get webhook info

    Get information about a specific webhook.

    GET /lists/{list_id}/webhooks/{webhook_id}

  • Read

    List signup forms

    Get signup forms for a specific list.

    GET /lists/{list_id}/signup-forms

  • Read

    List locations

    Get the locations (countries) that the list's subscribers have been tagged to based on geocoding their IP address.

    GET /lists/{list_id}/locations

  • Read

    Get information about all surveys for a list

    Get information about all available surveys for a specific list.

    GET /lists/{list_id}/surveys

  • Read

    Get survey

    Get details about a specific survey.

    GET /lists/{list_id}/surveys/{survey_id}

  • Write

    Add list

    Create a new list in your Mailchimp account.

    POST /lists

  • Write

    Update lists

    Update the settings for a specific list.

    PATCH /lists/{list_id}

  • Write

    Add interest category

    Create a new interest category.

    POST /lists/{list_id}/interest-categories

  • Write

    Update interest category

    Update a specific interest category.

    PATCH /lists/{list_id}/interest-categories/{interest_category_id}

  • Write

    Add interest in category

    Create a new interest or 'group name' for a specific category.

    POST /lists/{list_id}/interest-categories/{interest_category_id}/interests

  • Write

    Update interest in category

    Update interests or 'group names' for a specific category.

    PATCH /lists/{list_id}/interest-categories/{interest_category_id}/interests/{interest_id}

  • Write

    Add segment

    Create a new segment in a specific list.

    POST /lists/{list_id}/segments

  • Write

    Add member to segment

    Add a member to a static segment.

    POST /lists/{list_id}/segments/{segment_id}/members

  • Write

    Add member to list

    Add a new member to the list.

    POST /lists/{list_id}/members

  • Write

    Update list member

    Update information for a specific list member.

    PATCH /lists/{list_id}/members/{subscriber_hash}

  • Write

    Add event

    Add an event for a list member.

    POST /lists/{list_id}/members/{subscriber_hash}/events

  • Write

    Add member note

    Add a new note for a specific subscriber.

    POST /lists/{list_id}/members/{subscriber_hash}/notes

  • Write

    Update note

    Update a specific note for a specific list member.

    PATCH /lists/{list_id}/members/{subscriber_hash}/notes/{note_id}

  • Write

    Add merge field

    Add a new merge field for a specific audience.

    POST /lists/{list_id}/merge-fields

  • Write

    Update merge field

    Update a specific merge field.

    PATCH /lists/{list_id}/merge-fields/{merge_id}

  • Write

    Add webhook

    Create a new webhook for a specific list.

    POST /lists/{list_id}/webhooks

  • Write

    Update webhook

    Update the settings for an existing webhook.

    PATCH /lists/{list_id}/webhooks/{webhook_id}

  • Write

    Customize signup form

    Customize a list's default signup form.

    POST /lists/{list_id}/signup-forms

  • Write

    Create survey

    Create a draft survey for an audience.

    POST /lists/{list_id}/surveys

  • Write

    Replicate survey

    Replicate a survey.

    POST /lists/{list_id}/surveys/{survey_id}/actions/replicate

  • Destructive

    Delete list

    Delete a list from your Mailchimp account. If you delete a list, you'll lose the list history—including subscriber activity, unsubscribes, complaints, and bounces. You’ll also lose subscribers’ email addresses, unless you exported and backed up your list.

    DELETE /lists/{list_id}

  • Destructive

    Batch subscribe or unsubscribe

    Batch subscribe or unsubscribe list members.

    POST /lists/{list_id}

  • Destructive

    Delete interest category

    Delete a specific interest category.

    DELETE /lists/{list_id}/interest-categories/{interest_category_id}

  • Destructive

    Delete interest in category

    Delete interests or group names in a specific category.

    DELETE /lists/{list_id}/interest-categories/{interest_category_id}/interests/{interest_id}

  • Destructive

    Delete segment

    Delete a specific segment in a list.

    DELETE /lists/{list_id}/segments/{segment_id}

  • Destructive

    Update segment

    Update a specific segment in a list.

    PATCH /lists/{list_id}/segments/{segment_id}

  • Destructive

    Batch add or remove members

    Batch add/remove list members to static segment

    POST /lists/{list_id}/segments/{segment_id}

  • Destructive

    Remove list member from segment

    Remove a member from the specified static segment.

    DELETE /lists/{list_id}/segments/{segment_id}/members/{subscriber_hash}

  • Destructive

    Add or update list member

    Add or update a list member.

    PUT /lists/{list_id}/members/{subscriber_hash}

  • Destructive

    Archive list member

    Archive a list member. To permanently delete, use the delete-permanent action.

    DELETE /lists/{list_id}/members/{subscriber_hash}

  • Destructive

    Add or remove member tags

    Add or remove tags from a list member. If a tag that does not exist is passed in and set as 'active', a new tag will be created.

    POST /lists/{list_id}/members/{subscriber_hash}/tags

  • Destructive

    Delete note

    Delete a specific note for a specific list member.

    DELETE /lists/{list_id}/members/{subscriber_hash}/notes/{note_id}

  • Destructive

    Delete list member

    Delete all personally identifiable information related to a list member, and remove them from a list. This will make it impossible to re-import the list member.

    POST /lists/{list_id}/members/{subscriber_hash}/actions/delete-permanent

  • Destructive

    Delete merge field

    Delete a specific merge field.

    DELETE /lists/{list_id}/merge-fields/{merge_id}

  • Destructive

    Delete webhook

    Delete a specific webhook in a list.

    DELETE /lists/{list_id}/webhooks/{webhook_id}

  • Destructive

    Update survey

    Update a survey. When sections is provided, send the complete section list in display order. Any existing section not included is deleted.

    PATCH /lists/{list_id}/surveys/{survey_id}

  • Destructive

    Delete survey

    Delete a survey.

    DELETE /lists/{list_id}/surveys/{survey_id}

Surveys

  • Write

    Publish a Survey

    Publish a survey that is in draft, unpublished, or has been previously published and edited.

    POST /lists/{list_id}/surveys/{survey_id}/actions/publish

  • Write

    Unpublish a Survey

    Unpublish a survey that has been published.

    POST /lists/{list_id}/surveys/{survey_id}/actions/unpublish

  • Write

    Create a Survey Campaign

    Utilize the List ID and Survey ID to generate a Campaign that links to your survey.

    POST /lists/{list_id}/surveys/{survey_id}/actions/create-email

Landing Pages

  • Read

    List landing pages

    Get all landing pages.

    GET /landing-pages

  • Read

    Get landing page info

    Get information about a specific page.

    GET /landing-pages/{page_id}

  • Read

    Get landing page content

    Get the the HTML for your landing page.

    GET /landing-pages/{page_id}/content

  • Write

    Add landing page

    Create an unpublished and contentless Mailchimp landing page.

    POST /landing-pages

  • Write

    Update landing page

    Update a landing page.

    PATCH /landing-pages/{page_id}

  • Write

    Publish landing page

    Publish a landing page that is in draft, unpublished, or has been previously published and edited.

    POST /landing-pages/{page_id}/actions/publish

  • Write

    Unpublish landing page

    Unpublish a landing page that is in draft or has been published.

    POST /landing-pages/{page_id}/actions/unpublish

  • Destructive

    Delete landing page

    Delete a landing page.

    DELETE /landing-pages/{page_id}

Reports

  • Read

    List campaign reports

    Get campaign reports.

    GET /reports

  • Read

    Get campaign report

    Get report details for a specific sent campaign.

    GET /reports/{campaign_id}

  • Read

    List abuse reports

    Get a list of abuse complaints for a specific campaign.

    GET /reports/{campaign_id}/abuse-reports

  • Read

    Get abuse report

    Get information about a specific abuse report for a campaign.

    GET /reports/{campaign_id}/abuse-reports/{report_id}

  • Read

    List campaign feedback

    Get feedback based on a campaign's statistics. Advice feedback is based on campaign stats like opens, clicks, unsubscribes, bounces, and more.

    GET /reports/{campaign_id}/advice

  • Read

    List campaign details

    Get information about clicks on specific links in your Mailchimp campaigns.

    GET /reports/{campaign_id}/click-details

  • Read

    Get campaign link details

    Get click details for a specific link in a campaign.

    GET /reports/{campaign_id}/click-details/{link_id}

  • Read

    List clicked link subscribers

    Get information about list members who clicked on a specific link in a campaign.

    GET /reports/{campaign_id}/click-details/{link_id}/members

  • Read

    Get clicked link subscriber

    Get information about a specific subscriber who clicked a link in a specific campaign.

    GET /reports/{campaign_id}/click-details/{link_id}/members/{subscriber_hash}

  • Read

    List campaign open details

    Get detailed information about any campaign emails that were opened by a list member.

    GET /reports/{campaign_id}/open-details

  • Read

    Get opened campaign subscriber

    Get information about a specific subscriber who opened a campaign.

    GET /reports/{campaign_id}/open-details/{subscriber_hash}

  • Read

    List domain performance stats

    Get statistics for the top-performing email domains in a campaign.

    GET /reports/{campaign_id}/domain-performance

  • Read

    List EepURL activity

    Get a summary of social activity for the campaign, tracked by EepURL.

    GET /reports/{campaign_id}/eepurl

  • Read

    List email activity

    Get a list of member's subscriber activity in a specific campaign.

    GET /reports/{campaign_id}/email-activity

  • Read

    Get subscriber email activity

    Get a specific list member's activity in a campaign including opens, clicks, and bounces.

    GET /reports/{campaign_id}/email-activity/{subscriber_hash}

  • Read

    List top open activities

    Get top open locations for a specific campaign.

    GET /reports/{campaign_id}/locations

  • Read

    List campaign recipients

    Get information about campaign recipients.

    GET /reports/{campaign_id}/sent-to

  • Read

    Get campaign recipient info

    Get information about a specific campaign recipient.

    GET /reports/{campaign_id}/sent-to/{subscriber_hash}

  • Read

    List child campaign reports

    Get a list of reports with child campaigns for a specific parent campaign.

    GET /reports/{campaign_id}/sub-reports

  • Read

    List unsubscribed members

    Get information about members who have unsubscribed from a specific campaign.

    GET /reports/{campaign_id}/unsubscribed

  • Read

    Get unsubscribed member

    Get information about a specific list member who unsubscribed from a campaign.

    GET /reports/{campaign_id}/unsubscribed/{subscriber_hash}

  • Read

    List campaign product activity

    Get breakdown of product activity for a campaign

    GET /reports/{campaign_id}/ecommerce-product-activity

Templates

  • Read

    List templates

    Get a list of an account's available templates.

    GET /templates

  • Read

    Get template info

    Get information about a specific template.

    GET /templates/{template_id}

  • Read

    View default content

    Get the sections that you can edit in a template, including each section's default content.

    GET /templates/{template_id}/default-content

  • Write

    Add template

    Create a new template for the account. Only Classic templates are supported.

    POST /templates

  • Write

    Update template

    Update the name, HTML, or `folder_id` of an existing template.

    PATCH /templates/{template_id}

  • Destructive

    Delete template

    Delete a specific template.

    DELETE /templates/{template_id}

Ecommerce

  • Read

    List account orders

    Get information about an account's orders.

    GET /ecommerce/orders

  • Read

    List stores

    Get information about all stores in the account.

    GET /ecommerce/stores

  • Read

    Get store info

    Get information about a specific store.

    GET /ecommerce/stores/{store_id}

  • Read

    List carts

    Get information about a store's carts.

    GET /ecommerce/stores/{store_id}/carts

  • Read

    Get cart info

    Get information about a specific cart.

    GET /ecommerce/stores/{store_id}/carts/{cart_id}

  • Read

    List cart line items

    Get information about a cart's line items.

    GET /ecommerce/stores/{store_id}/carts/{cart_id}/lines

  • Read

    Get cart line item

    Get information about a specific cart line item.

    GET /ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id}

  • Read

    List customers

    Get information about a store's customers.

    GET /ecommerce/stores/{store_id}/customers

  • Read

    Get customer info

    Get information about a specific customer.

    GET /ecommerce/stores/{store_id}/customers/{customer_id}

  • Read

    List promo rules

    Get information about a store's promo rules.

    GET /ecommerce/stores/{store_id}/promo-rules

  • Read

    Get promo rule

    Get information about a specific promo rule.

    GET /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}

  • Read

    List promo codes

    Get information about a store's promo codes.

    GET /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes

  • Read

    Get promo code

    Get information about a specific promo code.

    GET /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes/{promo_code_id}

  • Read

    List orders

    Get information about a store's orders.

    GET /ecommerce/stores/{store_id}/orders

  • Read

    Get order info

    Get information about a specific order.

    GET /ecommerce/stores/{store_id}/orders/{order_id}

  • Read

    List order line items

    Get information about an order's line items.

    GET /ecommerce/stores/{store_id}/orders/{order_id}/lines

  • Read

    Get order line item

    Get information about a specific order line item.

    GET /ecommerce/stores/{store_id}/orders/{order_id}/lines/{line_id}

  • Read

    List product

    Get information about a store's products.

    GET /ecommerce/stores/{store_id}/products

  • Read

    Get product info

    Get information about a specific product.

    GET /ecommerce/stores/{store_id}/products/{product_id}

  • Read

    List product variants

    Get information about a product's variants.

    GET /ecommerce/stores/{store_id}/products/{product_id}/variants

  • Read

    Get product variant info

    Get information about a specific product variant.

    GET /ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id}

  • Read

    List product images

    Get information about a product's images.

    GET /ecommerce/stores/{store_id}/products/{product_id}/images

  • Read

    Get product image info

    Get information about a specific product image.

    GET /ecommerce/stores/{store_id}/products/{product_id}/images/{image_id}

  • Write

    Add store

    Add a new store to your Mailchimp account.

    POST /ecommerce/stores

  • Write

    Update store

    Update a store.

    PATCH /ecommerce/stores/{store_id}

  • Write

    Add cart

    Add a new cart to a store.

    POST /ecommerce/stores/{store_id}/carts

  • Write

    Update cart

    Update a specific cart.

    PATCH /ecommerce/stores/{store_id}/carts/{cart_id}

  • Write

    Add cart line item

    Add a new line item to an existing cart.

    POST /ecommerce/stores/{store_id}/carts/{cart_id}/lines

  • Write

    Update cart line item

    Update a specific cart line item.

    PATCH /ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id}

  • Write

    Add customer

    Add a new customer to a store.

    POST /ecommerce/stores/{store_id}/customers

  • Write

    Update customer

    Update a customer.

    PATCH /ecommerce/stores/{store_id}/customers/{customer_id}

  • Write

    Add promo rule

    Add a new promo rule to a store.

    POST /ecommerce/stores/{store_id}/promo-rules

  • Write

    Update promo rule

    Update a promo rule.

    PATCH /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}

  • Write

    Add promo code

    Add a new promo code to a store.

    POST /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes

  • Write

    Update promo code

    Update a promo code.

    PATCH /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes/{promo_code_id}

  • Write

    Add order

    Add a new order to a store.

    POST /ecommerce/stores/{store_id}/orders

  • Write

    Add order line item

    Add a new line item to an existing order.

    POST /ecommerce/stores/{store_id}/orders/{order_id}/lines

  • Write

    Update order line item

    Update a specific order line item.

    PATCH /ecommerce/stores/{store_id}/orders/{order_id}/lines/{line_id}

  • Write

    Add product

    Add a new product to a store.

    POST /ecommerce/stores/{store_id}/products

  • Write

    Update product

    Update a specific product.

    PATCH /ecommerce/stores/{store_id}/products/{product_id}

  • Write

    Add product variant

    Add a new variant to the product.

    POST /ecommerce/stores/{store_id}/products/{product_id}/variants

  • Write

    Update product variant

    Update a product variant.

    PATCH /ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id}

  • Write

    Add product image

    Add a new image to the product.

    POST /ecommerce/stores/{store_id}/products/{product_id}/images

  • Write

    Update product image

    Update a product image.

    PATCH /ecommerce/stores/{store_id}/products/{product_id}/images/{image_id}

  • Destructive

    Delete store

    Delete a store. Deleting a store will also delete any associated subresources, including Customers, Orders, Products, and Carts.

    DELETE /ecommerce/stores/{store_id}

  • Destructive

    Delete cart

    Delete a cart.

    DELETE /ecommerce/stores/{store_id}/carts/{cart_id}

  • Destructive

    Delete cart line item

    Delete a specific cart line item.

    DELETE /ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id}

  • Destructive

    Add or update customer

    Add or update a customer.

    PUT /ecommerce/stores/{store_id}/customers/{customer_id}

  • Destructive

    Delete customer

    Delete a customer from a store.

    DELETE /ecommerce/stores/{store_id}/customers/{customer_id}

  • Destructive

    Delete promo rule

    Delete a promo rule from a store.

    DELETE /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}

  • Destructive

    Delete promo code

    Delete a promo code from a store.

    DELETE /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes/{promo_code_id}

  • Destructive

    Add or update order

    Add or update an order.

    PUT /ecommerce/stores/{store_id}/orders/{order_id}

  • Destructive

    Update order

    Update a specific order.

    PATCH /ecommerce/stores/{store_id}/orders/{order_id}

  • Destructive

    Delete order

    Delete an order.

    DELETE /ecommerce/stores/{store_id}/orders/{order_id}

  • Destructive

    Delete order line item

    Delete a specific order line item.

    DELETE /ecommerce/stores/{store_id}/orders/{order_id}/lines/{line_id}

  • Destructive

    Create or update product

    Update a specific product.

    PUT /ecommerce/stores/{store_id}/products/{product_id}

  • Destructive

    Delete product

    Delete a product.

    DELETE /ecommerce/stores/{store_id}/products/{product_id}

  • Destructive

    Add or update product variant

    Add or update a product variant.

    PUT /ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id}

  • Destructive

    Delete product variant

    Delete a product variant.

    DELETE /ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id}

  • Destructive

    Delete product image

    Delete a product image.

    DELETE /ecommerce/stores/{store_id}/products/{product_id}/images/{image_id}

Search Campaigns

  • Read

    Search campaigns

    Search all campaigns for the specified query terms.

    GET /search-campaigns

Sms campaigns

  • Read

    List SMS campaigns

    Get all SMS campaigns in an account.

    GET /sms-campaigns

  • Read

    Get SMS campaign info

    Get information about a specific SMS campaign.

    GET /sms-campaigns/{sms_campaign_id}

  • Read

    Get SMS campaign content

    Get the content for an SMS campaign.

    GET /sms-campaigns/{sms_campaign_id}/content

  • Write

    Add SMS campaign

    Create a new SMS campaign.

    POST /sms-campaigns

  • Write

    Update SMS campaign settings

    Update some or all of the settings for a specific SMS campaign.

    PATCH /sms-campaigns/{sms_campaign_id}

  • Write

    Send SMS campaign

    Send an SMS campaign.

    POST /sms-campaigns/{sms_campaign_id}/actions/send

  • Write

    Schedule SMS campaign

    Schedule an SMS campaign to send at a specific time.

    POST /sms-campaigns/{sms_campaign_id}/actions/schedule

  • Destructive

    Delete SMS campaign

    Remove an SMS campaign from your Mailchimp account.

    DELETE /sms-campaigns/{sms_campaign_id}

  • Destructive

    Cancel SMS campaign send

    Cancel a scheduled or sending SMS campaign.

    POST /sms-campaigns/{sms_campaign_id}/actions/cancel-send

  • Destructive

    Set SMS campaign content

    Set the content for an SMS campaign.

    PUT /sms-campaigns/{sms_campaign_id}/content

Search Members

  • Read

    Search members

    Search for list members. This search can be restricted to a specific list, or can be used to search across all lists in an account.

    GET /search-members

Ping

  • Read

    Ping

    A health check for the API that won't return any account-specific information.

    GET /ping

Facebook Ads

  • Read

    List facebook ads

    Get list of Facebook ads.

    GET /facebook-ads

  • Read

    Get facebook ad info

    Get details of a Facebook ad.

    GET /facebook-ads/{outreach_id}

Reporting

  • Read

    List facebook ads reports

    Get reports of Facebook ads.

    GET /reporting/facebook-ads

  • Read

    Get facebook ad report

    Get report of a Facebook ad.

    GET /reporting/facebook-ads/{outreach_id}

  • Read

    List facebook ecommerce report

    Get breakdown of product activity for an outreach.

    GET /reporting/facebook-ads/{outreach_id}/ecommerce-product-activity

  • Read

    Get landing page report

    Get report of a landing page.

    GET /reporting/landing-pages/{outreach_id}

  • Read

    List landing pages reports

    Get reports of landing pages.

    GET /reporting/landing-pages

  • Read

    List survey reports

    Get reports for surveys.

    GET /reporting/surveys

  • Read

    Get survey report

    Get report for a survey.

    GET /reporting/surveys/{survey_id}

  • Read

    List survey question reports

    Get reports for survey questions.

    GET /reporting/surveys/{survey_id}/questions

  • Read

    Get survey question report

    Get report for a survey question.

    GET /reporting/surveys/{survey_id}/questions/{question_id}

  • Read

    List answers for question

    Get answers for a survey question.

    GET /reporting/surveys/{survey_id}/questions/{question_id}/answers

  • Read

    List survey responses

    Get responses to a survey.

    GET /reporting/surveys/{survey_id}/responses

  • Read

    Get survey response

    Get a single survey response.

    GET /reporting/surveys/{survey_id}/responses/{response_id}

Verified Domains

  • Read

    Get domain info

    Get the details for a single domain on the account.

    GET /verified-domains/{domain_name}

  • Read

    List sending domains

    Get all of the sending domains on the account.

    GET /verified-domains

  • Write

    Verify domain

    Verify a domain for sending.

    POST /verified-domains/{domain_name}/actions/verify

  • Write

    Add domain to account

    Add a domain to the account.

    POST /verified-domains

  • Destructive

    Delete domain

    Delete a verified domain from the account.

    DELETE /verified-domains/{domain_name}

See How connections work for access and permissions, or browse all integrations.