Mailchimp API
Tools that enable LLMs to interact directly with the Mailchimp Marketing API.
The MailchimpMarketingApi toolkit enables seamless integration with the Mailchimp Marketing API, allowing developers to manage marketing efforts effectively. It empowers users to execute various operations related to audience management, email campaigns, and e-commerce functionality.
Capabilities:
- Manage and update audience members, lists, and segments.
- Create and distribute email campaigns with tracking capabilities.
- Integrate e-commerce functionality including product management and order processing.
- Retrieve analytics and performance reports for better insights.
- Automate marketing workflows with ease.
OAuth:
- Provider: Mailchimp
- Scopes: None
Secrets:
- No secret types or names are required.
Available tools(278)
| Tool name | Description | Secrets | |
|---|---|---|---|
Add a new merge field to a specific audience.
This tool is used to add a new merge field for a specific audience in Mailchimp. It should be called when you need to enhance the audience profile with additional information fields.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| |||
Add feedback to a specific Mailchimp campaign.
Use this tool to submit feedback for a particular campaign in Mailchimp. This is helpful when users want to provide input or comments about a campaign. | |||
Add a new cart to an ecommerce store.
This tool adds a new cart to a specified ecommerce store using Mailchimp Marketing. It should be called when a user needs to create a new cart for a store.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| |||
Add a new customer to an ecommerce store.
This tool adds a new customer to a specified ecommerce store. It should be called when a new customer needs to be registered in the store's system.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| |||
Add a new line item to an existing shopping cart.
Use this tool to add a product to a specific cart by specifying the store and cart IDs. This enables updating shopping carts with new items in an e-commerce context. | |||
Add an event for a list member in Mailchimp.
This tool adds an event to a specific list member in Mailchimp. It should be called when you need to track a specific activity or event for a subscriber in a mailing list.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| |||
Add a new member to a Mailchimp list.
Use this tool to add a new subscriber to a specific Mailchimp list. It should be called when you need to manage mailing lists by adding new contacts.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path, query parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path, query parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| |||
Add a member to a Mailchimp static segment.
Use this tool to add a new member to a specific static segment within a Mailchimp list. This is helpful for updating subscriber lists with targeted segments. | |||
Add a new e-commerce store to your Mailchimp account.
Use this tool to add a new store to your Mailchimp account for managing e-commerce activities. Call this tool when you need to integrate a new store with Mailchimp.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | |||
Add a new note for a specific subscriber in Mailchimp.
Use this tool to add a note to a subscriber's profile in a specific list on Mailchimp. This is useful for keeping track of important information or interactions related to the subscriber. | |||
Add a new line item to an existing order.
Use this tool to add a new product line to an existing order in an ecommerce store. Ideal for updating orders with additional items, changing quantities, or modifying product details.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| |||
Add a new order to an ecommerce store.
This tool adds a new order to a specified store using the store's ID. It should be called when you need to record a new purchase or transaction in your ecommerce system.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| |||
Add or update a customer in an eCommerce store.
Use this tool to add a new customer or update an existing customer's information in a specific eCommerce store using Mailchimp Marketing.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| |||
Add or update a member in a Mailchimp list.
Use this tool to add a new member to a specific Mailchimp list or update the information of an existing member. This is useful for managing list subscriptions effectively.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path, query parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path, query parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| |||
Add a new image to a specific product.
This tool is used to add a new image to an existing product in a store's e-commerce catalog. It should be called when you need to update the product's visual information by uploading an additional image. | |||
Add a new product to a Mailchimp store.
Use this tool to add a new product to a specific store in Mailchimp. This is useful for updating store inventories or launching new products.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| |||
Add a new variant to an existing product in Mailchimp.
This tool is used to add a new variant to an existing product within a specific store on Mailchimp. Use this when you need to add, update, or expand product options such as sizes or colors within your Mailchimp store.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| |||
Add a new promo code to an ecommerce store.
Use this tool to add a new promotional code to a specific store in the ecommerce platform. This is useful for managing discounts and promotions within the store. | |||
Add a new promo rule to an e-commerce store on Mailchimp.
This tool is used to add a new promotional rule to a specific e-commerce store within Mailchimp. It is ideal for automating the management of store promotions.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| |||
Add a subscriber to an automation workflow.
Use this tool to manually add a subscriber to a Mailchimp workflow, bypassing default triggers, or to initiate a series of automated emails. | |||
Add a verified domain to your Mailchimp account.
Use this tool to add a verified domain to your Mailchimp account. This is useful for managing communication and ensuring trust with your recipients. | |||
Archives a contact in a Mailchimp audience.
This tool archives a specific contact within a given audience in Mailchimp. Use this when you need to remove a contact from active participation without deleting them permanently. | |||
Archives a member from a Mailchimp list.
Use this tool to archive a member from a specific Mailchimp list when they should no longer receive communications. Note that this is not a permanent deletion. | |||
Permanently archive a Mailchimp automation.
Use this tool to permanently archive a Mailchimp automation workflow. Once archived, the automation cannot be restarted, but the report data will be kept. You can replicate the archived automation if needed. | |||
Cancels a running batch request to stop its execution.
This tool stops a batch request from running in Mailchimp Marketing. It should be called to cancel a long-running batch request. After calling this, results of any completed operations in the batch will not be available. |
Selected tools
No tools selected.
Click "Show all tools" to add tools.
Requirements
Select tools to see requirements
MailchimpMarketingApi.AddAudienceMergeField
Add a new merge field to a specific audience. This tool is used to add a new merge field for a specific audience in Mailchimp. It should be called when you need to enhance the audience profile with additional information fields. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
audience_list_id | string | Optional | The unique ID of the Mailchimp audience list to which the merge field will be added. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'postListsIdMergeFields'.MailchimpMarketingApi.AddCampaignFeedback
Add feedback to a specific Mailchimp campaign. Use this tool to submit feedback for a particular campaign in Mailchimp. This is helpful when users want to provide input or comments about a campaign.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
campaign_unique_id | string | Required | The unique identifier for the Mailchimp campaign to which feedback will be added. |
feedback_content | string | Required | The content of the feedback to be added to the campaign. |
editable_block_id | integer | Optional | The ID of the editable block the feedback addresses in the campaign. |
is_feedback_complete | boolean | Optional | Indicates whether the feedback is complete. Use 'true' if complete and 'false' otherwise. |
Requirements
Output
json— Response from the API endpoint 'postCampaignsIdFeedback'.MailchimpMarketingApi.AddCartToStore
Add a new cart to an ecommerce store. This tool adds a new cart to a specified ecommerce store using Mailchimp Marketing. It should be called when a user needs to create a new cart for a store. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
store_identifier | string | Optional | The unique identifier for the ecommerce store where the new cart will be added. This is essential to specify the target store. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'postEcommerceStoresIdCarts'.MailchimpMarketingApi.AddCustomerToStore
Add a new customer to an ecommerce store. This tool adds a new customer to a specified ecommerce store. It should be called when a new customer needs to be registered in the store's system. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
store_identifier | string | Optional | The unique identifier for the ecommerce store where the customer will be added. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'postEcommerceStoresIdCustomers'.MailchimpMarketingApi.AddLineItemToCart
Add a new line item to an existing shopping cart. Use this tool to add a product to a specific cart by specifying the store and cart IDs. This enables updating shopping carts with new items in an e-commerce context.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
cart_identifier | string | Required | The unique identifier for the cart to which the line item will be added. |
cart_line_item_identifier | string | Required | A unique identifier for the cart line item. |
line_item_price | number | Required | The monetary price for the line item being added to the cart. Must be a numeric value. |
line_item_quantity | integer | Required | The number of units for the specified product variant in the cart. |
product_id | string | Required | A unique identifier for the product to be added to the cart line item. |
product_variant_id | string | Required | A unique identifier for the product variant to be added to the cart. This is necessary to specify which variant of the product is being added. |
store_identifier | string | Required | The unique identifier for the store. This is necessary to specify which store's cart will be updated. |
Requirements
Output
json— Response from the API endpoint 'postEcommerceStoresIdCartsIdLines'.MailchimpMarketingApi.AddListMemberEvent
Add an event for a list member in Mailchimp. This tool adds an event to a specific list member in Mailchimp. It should be called when you need to track a specific activity or event for a subscriber in a mailing list. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
list_identifier | string | Optional | The unique identifier for the Mailchimp list. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
list_member_identifier | string | Optional | The MD5 hash of the lowercase version of the list member's email address, or the email address/contact_id. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'postListMemberEvents'.MailchimpMarketingApi.AddMemberToMailchimpList
Add a new member to a Mailchimp list. Use this tool to add a new subscriber to a specific Mailchimp list. It should be called when you need to manage mailing lists by adding new contacts. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
list_unique_id | string | Optional | The unique ID for the Mailchimp list to which a new member will be added. This ID can be found in the Mailchimp account settings. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
bypass_merge_field_validation | string | Optional | Set to true to accept member data without required merge fields. Defaults to false. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'postListsIdMembers'.MailchimpMarketingApi.AddMemberToStaticSegment
Add a member to a Mailchimp static segment. Use this tool to add a new member to a specific static segment within a Mailchimp list. This is helpful for updating subscriber lists with targeted segments.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
list_unique_id | string | Required | The unique ID for the Mailchimp list to which the segment belongs. |
segment_id | string | Required | The unique ID for the segment to which the member will be added. |
subscriber_email_address | string | Required | The email address of the subscriber to be added to the static segment. |
Requirements
Output
json— Response from the API endpoint 'postListsIdSegmentsIdMembers'.MailchimpMarketingApi.AddNewEcommerceStore
Add a new e-commerce store to your Mailchimp account. Use this tool to add a new store to your Mailchimp account for managing e-commerce activities. Call this tool when you need to integrate a new store with Mailchimp. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'postEcommerceStores'.MailchimpMarketingApi.AddNoteToSubscriber
Add a new note for a specific subscriber in Mailchimp. Use this tool to add a note to a subscriber's profile in a specific list on Mailchimp. This is useful for keeping track of important information or interactions related to the subscriber.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
list_unique_id | string | Required | The unique identifier for the Mailchimp list. This is required to add a note to a subscriber's profile in the specified list. |
subscriber_email_hash | string | Required | MD5 hash of the lowercase version of the subscriber's email address. |
subscriber_note_content | string | Optional | The content of the note for a subscriber. It must be limited to 1,000 characters. |
Requirements
Output
json— Response from the API endpoint 'postListsIdMembersIdNotes'.MailchimpMarketingApi.AddOrderLineItem
Add a new line item to an existing order. Use this tool to add a new product line to an existing order in an ecommerce store. Ideal for updating orders with additional items, changing quantities, or modifying product details. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
store_identifier | string | Optional | The unique identifier for the store where the order is placed. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
order_id | string | Optional | The unique identifier for the order in the store, used to specify which order to update. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'postEcommerceStoresIdOrdersIdLines'.MailchimpMarketingApi.AddOrderToStore
Add a new order to an ecommerce store. This tool adds a new order to a specified store using the store's ID. It should be called when you need to record a new purchase or transaction in your ecommerce system. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
store_identifier | string | Optional | The unique identifier for the store where the order will be added. This should be a string value that accurately corresponds to an existing store in the system. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'postEcommerceStoresIdOrders'.MailchimpMarketingApi.AddOrUpdateCustomerInStore
Add or update a customer in an eCommerce store. Use this tool to add a new customer or update an existing customer's information in a specific eCommerce store using Mailchimp Marketing. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
store_identifier | string | Optional | The unique identifier for the eCommerce store where the customer will be added or updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
customer_identifier | string | Optional | The unique identifier for the customer in the specified store. This ID is necessary for adding or updating customer details. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'putEcommerceStoresIdCustomersId'.MailchimpMarketingApi.AddOrUpdateListMember
Add or update a member in a Mailchimp list. Use this tool to add a new member to a specific Mailchimp list or update the information of an existing member. This is useful for managing list subscriptions effectively. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
unique_list_id | string | Optional | The unique ID identifying the Mailchimp list where members are added or updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
subscriber_identifier | string | Optional | MD5 hash of the lowercase version of the member's email address, email address, or contact ID. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
bypass_merge_field_check | string | Optional | Set to true to allow member data without required merge fields. Defaults to false. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'putListsIdMembersId'.MailchimpMarketingApi.AddProductImage
Add a new image to a specific product. This tool is used to add a new image to an existing product in a store's e-commerce catalog. It should be called when you need to update the product's visual information by uploading an additional image.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
product_id | string | Required | The unique identifier for the product in the store. Required to specify which product the image will be added to. |
product_image_id | string | Required | A unique identifier for the product image to be added. |
product_image_url | string | Required | The URL of the image to be added to the product. |
store_id | string | Required | The unique identifier for the store where the product is hosted. Required to specify which store's catalog you are updating. |
product_variant_ids | array<string> | Optional | List of product variant IDs using the image. |
Requirements
Output
json— Response from the API endpoint 'postEcommerceStoresIdProductsIdImages'.MailchimpMarketingApi.AddProductToStore
Add a new product to a Mailchimp store. Use this tool to add a new product to a specific store in Mailchimp. This is useful for updating store inventories or launching new products. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
store_id | string | Optional | The unique identifier of the store where the product will be added. This is required to specify the target store. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'postEcommerceStoresIdProducts'.MailchimpMarketingApi.AddProductVariantMailchimp
Add a new variant to an existing product in Mailchimp. This tool is used to add a new variant to an existing product within a specific store on Mailchimp. Use this when you need to add, update, or expand product options such as sizes or colors within your Mailchimp store. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
store_identifier | string | Optional | The unique identifier for the store where the product variant will be added. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
product_id | string | Optional | The ID for the product within a store to which a new variant will be added. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'postEcommerceStoresIdProductsIdVariants'.MailchimpMarketingApi.AddPromoCodeToStore
Add a new promo code to an ecommerce store. Use this tool to add a new promotional code to a specific store in the ecommerce platform. This is useful for managing discounts and promotions within the store.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
promo_code | string | Required | The discount code for the promotion. It must be a UTF-8 string, with a maximum length of 50 characters. |
promo_code_identifier | string | Required | A unique identifier for the promo code. Must be UTF-8, max length 50. |
promo_rule_identifier | string | Required | The ID for the promotional rule associated with the store. |
promotion_redemption_url | string | Required | The URL used in the promotion campaign. Must be UTF-8, max length 2000 characters. |
store_identifier | string | Required | The unique identifier for the ecommerce store where the promo code will be added. |
is_promo_code_enabled | boolean | Optional | Specifies if the promo code is enabled. Use true to enable, false to disable. |
promo_code_usage_count | integer | Optional | Number of times the promo code has been used. This integer value helps track the utilization of the promo code. |
promotion_creation_datetime | string | Optional | The date and time the promotion was created, in ISO 8601 format. |
promotion_updated_datetime | string | Optional | The date and time the promotion was last updated, in ISO 8601 format. |
Requirements
Output
json— Response from the API endpoint 'postEcommerceStoresIdPromocodes'.MailchimpMarketingApi.AddStorePromoRule
Add a new promo rule to an e-commerce store on Mailchimp. This tool is used to add a new promotional rule to a specific e-commerce store within Mailchimp. It is ideal for automating the management of store promotions. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
store_id | string | Optional | The unique identifier for the store where the promo rule will be added. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'postEcommerceStoresIdPromorules'.MailchimpMarketingApi.AddSubscriberToWorkflow
Add a subscriber to an automation workflow. Use this tool to manually add a subscriber to a Mailchimp workflow, bypassing default triggers, or to initiate a series of automated emails.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
automation_workflow_id | string | Required | The unique identifier for the Automation workflow to which the subscriber will be added. |
subscriber_email_address | string | Required | The email address of the subscriber to add to the automation workflow. |
workflow_email_id | string | Required | The unique ID for the Automation workflow email. Required to identify the specific email in the workflow. |
Requirements
Output
json— Response from the API endpoint 'postAutomationsIdEmailsIdQueue'.MailchimpMarketingApi.AddVerifiedDomain
Add a verified domain to your Mailchimp account. Use this tool to add a verified domain to your Mailchimp account. This is useful for managing communication and ensuring trust with your recipients.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
verification_email_address | string | Required | The email address at the domain to verify, which will receive a two-factor challenge for verification. |
Requirements
Output
json— Response from the API endpoint 'createVerifiedDomain'.MailchimpMarketingApi.ArchiveContactMailchimp
Archives a contact in a Mailchimp audience. This tool archives a specific contact within a given audience in Mailchimp. Use this when you need to remove a contact from active participation without deleting them permanently.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
audience_unique_id | string | Required | The unique ID for the Mailchimp audience where the contact will be archived. |
contact_id | string | Required | The unique identifier for the contact to archive within the audience in Mailchimp. |
Requirements
Output
json— Response from the API endpoint 'postAudiencesContactsActionsArchive'.MailchimpMarketingApi.ArchiveListMember
Archives a member from a Mailchimp list. Use this tool to archive a member from a specific Mailchimp list when they should no longer receive communications. Note that this is not a permanent deletion.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mailing_list_id | string | Required | The unique identifier for the specific Mailchimp list to archive a member from. |
member_identifier | string | Required | The MD5 hash of the lowercase version of the list member's email address, or use the email address/contact_id directly. |
Requirements
Output
json— Response from the API endpoint 'deleteListsIdMembersId'.MailchimpMarketingApi.ArchiveMailchimpAutomation
Permanently archive a Mailchimp automation. Use this tool to permanently archive a Mailchimp automation workflow. Once archived, the automation cannot be restarted, but the report data will be kept. You can replicate the archived automation if needed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
automation_workflow_id | string | Required | The unique identifier for the Mailchimp automation workflow to archive. This ID is necessary to specify which automation you want to permanently end. |
Requirements
Output
json— Response from the API endpoint 'archiveAutomations'.MailchimpMarketingApi.CancelBatchRequest
Cancels a running batch request to stop its execution. This tool stops a batch request from running in Mailchimp Marketing. It should be called to cancel a long-running batch request. After calling this, results of any completed operations in the batch will not be available.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
batch_request_id | string | Required | The unique identifier for the batch request you want to cancel. |
Requirements
Output
json— Response from the API endpoint 'deleteBatchesId'.MailchimpMarketingApi.CancelCampaignSend
Cancel a sent campaign before all recipients receive it. Use to cancel a Regular or Plain-Text Campaign that has been sent, but not yet delivered to all recipients. Requires Mailchimp Pro.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
campaign_identifier | string | Required | The unique identifier for the Mailchimp campaign to be canceled. Used to specify which campaign's delivery is to be stopped. |
Requirements
Output
json— Response from the API endpoint 'postCampaignsIdActionsCancelSend'.MailchimpMarketingApi.CheckMailchimpApiHealth
Checks the health status of the Mailchimp API. Use this tool to verify the operational status of the Mailchimp Marketing API and ensure it's running without issues. This check does not return account-specific data.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'getPing'.MailchimpMarketingApi.ConfigureWebhookOnBatchComplete
Configure a webhook for batch processing completion alerts. This tool allows you to configure a webhook that triggers when any batch request completes processing in Mailchimp. Useful for automating follow-up actions based on batch completion events.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
webhook_url | string | Required | The URL where the webhook payload will be sent upon batch completion. It must be a valid and accessible URL. |
webhook_enabled | boolean | Optional | Set to True to enable the webhook to receive requests when batch processing completes. |
Requirements
Output
json— Response from the API endpoint 'postBatchWebhooks'.MailchimpMarketingApi.CreateAudienceContact
Create a new omni-channel contact for an audience. Use this tool to add a new contact to a Mailchimp audience for omni-channel marketing. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
audience_unique_id | string | Optional | The unique identifier for the audience in Mailchimp where the contact will be added. This ID is necessary to specify the target audience for the new contact. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
merge_field_validation_mode | string | Optional | Choose 'ignore_required_checks' to skip validation on required merge fields, or 'strict' to enforce validation. Defaults to 'strict' if not set. Only used when mode is 'execute'. |
data_processing_mode | string | Optional | Selects the data processing mode: 'historical' mode skips automations and webhooks, 'live' mode triggers them. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'createAudienceContact'.MailchimpMarketingApi.CreateCampaignFolder
Create a new campaign folder in Mailchimp. This tool is used to create a new campaign folder within Mailchimp marketing. Call this tool when you need to organize campaigns into folders for better management.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
folder_name | string | Required | The name to assign to the new campaign folder. It should be a descriptive string that helps identify the folder's contents. |
Requirements
Output
json— Response from the API endpoint 'postCampaignFolders'.MailchimpMarketingApi.CreateInterestCategory
Create a new interest category in a Mailchimp list. This tool is used to create a new interest category for a specified Mailchimp list. It is useful when you want to categorize subscriber interests within a list.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
category_description | string | Required | Text description of the interest category. Appears on signup forms, often phrased as a question. |
category_display_type | string | Required | Determines how the interest category appears on signup forms. Options include: 'checkboxes', 'dropdown', 'radio', or 'hidden'. |
list_unique_id | string | Required | The unique ID identifying the Mailchimp list where the interest category will be created. |
category_display_order | integer | Optional | The numerical order for displaying categories. Lower numbers appear first. |
Requirements
Output
json— Response from the API endpoint 'postListsIdInterestCategories'.MailchimpMarketingApi.CreateInterestGroup
Create a new interest group for a specific category. This tool is used to create a new interest or 'group name' within a specific interest category for a Mailchimp list. Use it when you need to organize and segment your list subscribers into specific interest groups.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
interest_category_unique_id | string | Required | The unique ID for the interest category to which the new group belongs. |
interest_group_name | string | Required | The name of the interest group, shown publicly on subscription forms. |
list_unique_id | string | Required | The unique ID for the Mailchimp list to which the interest group will be added. |
interest_display_order | integer | Optional | The order in which this interest is displayed relative to others. Use an integer value. |
Requirements
Output
json— Response from the API endpoint 'postListsIdInterestCategoriesIdInterests'.MailchimpMarketingApi.CreateMailchimpAccountExport
Create a new account export in your Mailchimp account. This tool initiates a new export of account data in your Mailchimp account. Use this when you need to generate and download account information from Mailchimp.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
include_export_stages | array<string> | Required | Array of export stages to include in the account export. |
export_starting_date | string | Optional | An ISO 8601 date to limit export to records created after this time. Excludes audiences. |
Requirements
Output
json— Response from the API endpoint 'postAccountExport'.MailchimpMarketingApi.CreateMailchimpAutomation
Create a new classic automation in Mailchimp. This tool initiates the creation of a new classic automation within your Mailchimp account, facilitating automated email campaigns.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
automation_workflow_type | string | Required | Specify the type of Automation workflow. Currently, only 'abandonedCart' is supported. |
automation_from_name | string | Optional | The 'from' name to display in the new automation emails. It should be an easily recognizable name for recipients. |
list_id | string | Optional | The unique identifier for the Mailchimp List to target with the automation. |
reply_to_email_address | string | Optional | The reply-to email address for the automation in Mailchimp. |
store_id | string | Optional | The unique identifier for the store in Mailchimp. Required to target specific automation to a store. |
Requirements
Output
json— Response from the API endpoint 'postAutomations'.MailchimpMarketingApi.CreateMailchimpCampaign
Create a new Mailchimp campaign quickly. This tool is used to initiate a new email campaign via Mailchimp. It should be called when a user wants to create and configure a marketing email or advertisement using Mailchimp's services. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'postCampaigns'.MailchimpMarketingApi.CreateMailchimpConnectedSite
Create a new Mailchimp connected site. This tool is used to create a new connected site in Mailchimp. It should be called whenever you need to integrate a new site with Mailchimp's marketing tools.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
connected_site_domain | string | Required | The domain of the site you want to connect to Mailchimp. |
site_unique_identifier | string | Required | A unique identifier string for the site. This is used to distinguish different connected sites in Mailchimp. |
Requirements
Output
json— Response from the API endpoint 'postConnectedSites'.MailchimpMarketingApi.CreateMailchimpLandingPage
Create an unpublished Mailchimp landing page. This tool is used to create a new, unpublished landing page in Mailchimp without any content. It should be called when there's a need to set up a basic landing page framework in Mailchimp.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
enable_restricted_data_processing | boolean | Optional | Enable restricted data processing under CCPA for tracking. True ensures compliance with CCPA. |
landing_page_description | string | Optional | Provide a description for the Mailchimp landing page. |
landing_page_name | string | Optional | The name of the landing page to be created. |
landing_page_template_id | integer | Optional | The integer ID representing the template of the Mailchimp landing page. |
landing_page_template_type | string | Optional | Specifies the template type for the landing page. Options are 'signup' or 'product'. |
landing_page_title | string | Optional | The title that appears in the browser's title bar for the landing page. |
mailchimp_list_id | string | Optional | The ID of the Mailchimp list associated with the landing page. |
store_identifier | string | Optional | The unique identifier of the store linked to this landing page. |
track_with_mailchimp | boolean | Optional | Set to true to use cookies for tracking unique visitors and calculating conversion rates. |
use_account_default_list | string | Optional | Set to 'true' to use the account's default list instead of specifying a list_id for the landing page. |
Requirements
Output
json— Response from the API endpoint 'postAllLandingPages'.MailchimpMarketingApi.CreateMailchimpList
Create a new list in your Mailchimp account. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'postLists'.MailchimpMarketingApi.CreateMailchimpSegment
Create a new segment in a specific Mailchimp list. This tool is used to create a new segment within a specified Mailchimp list. It should be called when you need to categorize or target specific subsets of your mailing list for marketing purposes.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
list_unique_id | string | Required | The unique identifier for the Mailchimp list where the new segment will be created. |
segment_name | string | Required | The name of the segment to be created in Mailchimp. |
emails_for_static_segment | array<string> | Optional | An array of emails for creating a static segment. An empty array means no subscribers. Cannot be used with 'options'. |
segment_match_conditions | array<json> | Optional | Array of conditions to define how the segment matches subscribers. Refer to the Mailchimp documentation for various condition types. |
segment_match_type | string | Optional | Specifies the match type for the segment conditions. Use 'any' to match any condition and 'all' to match all conditions. |
Requirements
Output
json— Response from the API endpoint 'postListsIdSegments'.MailchimpMarketingApi.CreateMailchimpTemplate
Create a new Classic template in Mailchimp. This tool is used to create a new Classic template in a Mailchimp account. It should be called when a user wants to add a new email template for marketing purposes.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
template_html_content | string | Required | The raw HTML content for the template, supporting Mailchimp Template Language. |
template_name | string | Required | The name assigned to the new template. It should be descriptive for easy identification. |
template_folder_id | string | Optional | The ID of the folder where the template will be stored. Ensure the folder exists in the Mailchimp account. |
Requirements
Output
json— Response from the API endpoint 'postTemplates'.MailchimpMarketingApi.CreateMailchimpWebhook
Create a new webhook for a specific Mailchimp list. Use this tool to set up a new webhook for a designated list in Mailchimp, allowing automated event-driven notifications. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
mailchimp_list_id | string | Optional | The unique ID for the Mailchimp list for which the webhook will be created. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'postListsIdWebhooks'.MailchimpMarketingApi.CreateNewFileManagerFolder
Create a new folder in Mailchimp's File Manager. Use this tool to create a new folder in Mailchimp's File Manager. This can be helpful for organizing files within your Mailchimp account.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
folder_name | string | Required | The desired name for the new folder in File Manager. |
Requirements
Output
json— Response from the API endpoint 'postFileManagerFolders'.MailchimpMarketingApi.CreateSurveyCampaignEmail
Generate a campaign email linking to a survey. Use this tool to create an email campaign that includes a link to a given survey, using specified List ID and Survey ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
list_identifier | string | Required | The unique identifier for the email list. |
survey_identifier | string | Required | The unique identifier for the survey to link in the campaign email. |
Requirements
Output
json— Response from the API endpoint 'postListsIdSurveysIdActionsCreateEmail'.MailchimpMarketingApi.CreateTemplateFolder
Create a new template folder in Mailchimp. Use this tool to add a new template folder in Mailchimp. This can help organize your templates into specific categories for better management.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
folder_name | string | Required | The desired name for the new template folder in Mailchimp. |
Requirements
Output
json— Response from the API endpoint 'postTemplateFolders'.MailchimpMarketingApi.CustomizeListSignupForm
Customize a list's default signup form in Mailchimp. Use this tool to modify the default signup form for a specific list in Mailchimp's marketing platform. Ideal for tailoring signup forms to better match branding or collect specific user information. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
list_unique_id | string | Optional | The unique ID for the Mailchimp list to customize the signup form. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'postListsIdSignupForms'.MailchimpMarketingApi.DeleteCampaignFolder
Delete a specific campaign folder in Mailchimp. Deletes a specified campaign folder in Mailchimp and marks all campaigns in it as 'unfiled'. This tool should be called when you need to remove a campaign folder and manage its contents accordingly.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
campaign_folder_id | string | Required | The unique ID for the Mailchimp campaign folder to be deleted. |
Requirements
Output
json— Response from the API endpoint 'deleteCampaignFoldersId'.MailchimpMarketingApi.DeleteCart
Deletes a specific cart from an ecommerce store. Use this tool to delete a cart from a specified store in the ecommerce system. It should be called when you need to remove a cart by providing a specific store and cart ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
cart_id | string | Required | The ID for the cart to be deleted from the store. |
store_identifier | string | Required | The unique identifier for the ecommerce store from which the cart will be deleted. |
Requirements
Output
json— Response from the API endpoint 'deleteEcommerceStoresIdCartsId'.MailchimpMarketingApi.DeleteCartLineItem
Delete a specific cart line item. Use this tool to delete a particular line item from a cart in an eCommerce store. Call this tool when you need to remove an item from a customer's shopping cart.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
cart_identifier | string | Required | The unique identifier for the cart in the eCommerce store. |
line_item_id | string | Required | ID for the line item in the cart to be deleted. |
store_identifier | string | Required | The unique identifier for the store from which the cart line item will be deleted. |
Requirements
Output
json— Response from the API endpoint 'deleteEcommerceStoresIdCartsLinesId'.MailchimpMarketingApi.DeleteEcommerceProduct
Delete a product from an eCommerce store. Use this tool to delete a specific product from a given eCommerce store in Mailchimp. It should be called when you want to remove a product based on its store and product ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
product_id | string | Required | The unique identifier for the product to delete from a store. |
store_id | string | Required | The unique identifier of the eCommerce store from which the product will be deleted. |
Requirements
Output
json— Response from the API endpoint 'deleteEcommerceStoresIdProductsId'.MailchimpMarketingApi.DeleteEcommerceStore
Delete a store and its associated subresources. Use this tool to delete an ecommerce store from Mailchimp Marketing. This action will remove the store along with any related Customers, Orders, Products, and Carts. Invoke this when a store needs to be completely removed from the system.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
store_identifier | string | Required | The unique identifier for the store to be deleted. |
Requirements
Output
json— Response from the API endpoint 'deleteEcommerceStoresId'.MailchimpMarketingApi.DeleteEmailTemplate
Delete a specific email template in Mailchimp.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
template_unique_id | string | Required | The unique identifier for the email template to be deleted in Mailchimp. |
Requirements
Output
json— Response from the API endpoint 'deleteTemplatesId'.MailchimpMarketingApi.DeleteFileManagerFile
Remove a specific file from Mailchimp's File Manager. Use this tool to delete a specific file by its ID from Mailchimp's File Manager. It helps manage and organize files by removing unwanted or outdated ones.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
file_manager_file_id | string | Required | The unique identifier for the file to be deleted from Mailchimp's File Manager. |
Requirements
Output
json— Response from the API endpoint 'deleteFileManagerFilesId'.MailchimpMarketingApi.DeleteFileManagerFolder
Delete a specific folder in the File Manager. Use this tool to delete a folder from Mailchimp's File Manager by specifying the folder ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
file_manager_folder_id | string | Required | The unique identifier for the folder to be deleted in the File Manager. |
Requirements
Output
json— Response from the API endpoint 'deleteFileManagerFoldersId'.MailchimpMarketingApi.DeleteInterestCategory
Delete a specific interest category from a list. Use this tool to delete a particular interest category from a specified list in Mailchimp. This might be called when managing email list segments and you need to remove an unwanted audience category.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
interest_category_id | string | Required | The unique ID of the interest category to be deleted from a list. |
list_id | string | Required | The unique ID for the Mailchimp list from which you want to delete an interest category. |
Requirements
Output
json— Response from the API endpoint 'deleteListsIdInterestCategoriesId'.MailchimpMarketingApi.DeleteInterestFromCategory
Delete an interest from a specific category. Use this tool to delete interests or group names within a specified category in Mailchimp. This is useful for managing interests in a mailing list.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
interest_category_id | string | Required | The unique ID for the interest category to delete the interest from. This ID is essential to specify the correct category in Mailchimp. |
interest_identifier | string | Required | The unique identifier for the specific interest or group name to be deleted. |
list_unique_id | string | Required | The unique ID for the list to be targeted for deleting an interest. |
Requirements
Output
json— Response from the API endpoint 'deleteListsIdInterestCategoriesIdInterestsId'.MailchimpMarketingApi.DeleteLandingPage
Delete a specified landing page. Use this tool to delete a landing page by providing its ID. Ideal for managing or updating landing pages by removing outdated or unnecessary ones.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
landing_page_id | string | Required | The unique ID for the landing page to be deleted. |
Requirements
Output
json— Response from the API endpoint 'deleteLandingPageId'.MailchimpMarketingApi.DeleteMailchimpCampaign
Delete a specific Mailchimp campaign. Use this tool to remove a campaign from your Mailchimp account by specifying the campaign ID. Ideal for managing or cleaning up your Mailchimp campaigns when they are no longer needed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
campaign_id | string | Required | The unique ID for the Mailchimp campaign to delete. |
Requirements
Output
json— Response from the API endpoint 'deleteCampaignsId'.MailchimpMarketingApi.DeleteMailchimpList
Delete a list from your Mailchimp account. Use this tool to permanently delete a list from your Mailchimp account. Deleting a list removes its history, including subscriber activity and email addresses, unless previously exported and backed up.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
list_id | string | Required | The unique ID for the Mailchimp list to be deleted. |
Requirements
Output
json— Response from the API endpoint 'deleteListsId'.MailchimpMarketingApi.DeleteMailchimpWebhook
Delete a specific webhook from a Mailchimp list. Use this tool to remove a webhook from a specified Mailchimp list by providing the list and webhook IDs.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
list_id | string | Required | The unique ID for the Mailchimp list from which the webhook will be deleted. This ID identifies the list containing the target webhook. |
webhook_id | string | Required | The unique identifier for the webhook to be deleted from the specified Mailchimp list. |
Requirements
Output
json— Response from the API endpoint 'deleteListsIdWebhooksId'.MailchimpMarketingApi.DeleteMemberDataPermanently
Permanently delete a list member's data in Mailchimp. This tool deletes all personally identifiable information related to a specific list member and removes them from the list, ensuring they cannot be re-imported.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
list_unique_id | string | Required | The unique ID of the list from which the member will be deleted. This ID identifies the target list in Mailchimp. |
member_email_hash | string | Required | MD5 hash of the lowercase version of the member's email address. |
Requirements
Output
json— Response from the API endpoint 'postListsIdMembersHashActionsDeletePermanent'.MailchimpMarketingApi.DeleteMemberNote
Delete a specific note for a list member. Use this tool to delete a specific note associated with a list member in Mailchimp. It should be called when there is a need to remove a note from a contact's record in a specific list.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
list_unique_id | string | Required | The unique identifier for the list in which the member's note is to be deleted. |
member_identifier | string | Required | The MD5 hash of the member's email (in lowercase), the email itself, or contact_id for identifying list members. |
note_id | string | Required | The ID for the specific note you want to delete for a list member. |
Requirements
Output
json— Response from the API endpoint 'deleteListsIdMembersIdNotesId'.MailchimpMarketingApi.DeleteMergeField
Delete a specific merge field from a Mailchimp list. Use this tool to remove a specific merge field from a Mailchimp list. This action is irreversible and will delete the specified merge field associated with the given list.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
list_unique_id | string | Required | The unique ID for the Mailchimp list from which to delete the merge field. |
merge_field_id | string | Required | The ID for the merge field to delete from the Mailchimp list. |
Requirements
Output
json— Response from the API endpoint 'deleteListsIdMergeFieldsId'.MailchimpMarketingApi.DeleteOrderInEcommerceStore
Delete an order from an eCommerce store. Use this tool to delete a specific order from an eCommerce store in Mailchimp by providing the store ID and order ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
ecommerce_store_id | string | Required | The unique identifier for the eCommerce store from which the order will be deleted. |
order_id | string | Required | The unique identifier for the order to delete within the store. |
Requirements
Output
json— Response from the API endpoint 'deleteEcommerceStoresIdOrdersId'.MailchimpMarketingApi.DeleteOrderLineItem
Delete a specific order line item. Call this tool to delete a specific line item from an order within an e-commerce store in Mailchimp. The tool should be used when a user needs to remove an item from an order completely.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
order_id | string | Required | The unique identifier for the order within a store. This is required to delete a line item from the specified order. |
order_line_item_id | string | Required | The unique identifier for the line item of an order to be deleted. |
store_id | string | Required | Unique identifier for the store from which the order line item will be deleted. |
Requirements
Output
json— Response from the API endpoint 'deleteEcommerceStoresIdOrdersIdLinesId'.MailchimpMarketingApi.DeleteProductImage
Delete an image from a product in an e-commerce store. This tool deletes a specified image from a product within an e-commerce store, identified by store, product, and image IDs. It should be called when a product image needs to be removed from a store's inventory.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
product_id | string | Required | The unique ID for the product in the store from which the image will be deleted. |
product_image_id | string | Required | The unique identifier for the product image to be deleted from the store's inventory. |
store_identifier | string | Required | The unique identifier for the e-commerce store. |
Requirements
Output
json— Response from the API endpoint 'deleteEcommerceStoresIdProductsIdImagesId'.MailchimpMarketingApi.DeleteProductVariant
Delete a product variant from an ecommerce store. Use this tool to delete a specific product variant in an ecommerce store on Mailchimp. Ideal for managing product inventories by removing obsolete or discontinued variants.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
product_id | string | Required | The unique identifier for the product within a store to which the variant belongs. |
product_variant_id | string | Required | The identifier for the product variant to be deleted from the store. |
store_identifier | string | Required | The unique identifier for the store from which the product variant will be deleted. |
Requirements
Output
json— Response from the API endpoint 'deleteEcommerceStoresIdProductsIdVariantsId'.MailchimpMarketingApi.DeletePromoRuleFromStore
Delete a promo rule from a specified ecommerce store. Use this tool to remove a promotional rule from an ecommerce store on Mailchimp. This action is irreversible and will delete the specified promo rule from the store identified by the store ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
promo_rule_id | string | Required | The unique identifier for the promo rule to be deleted from the store. |
store_id | string | Required | The unique identifier for the ecommerce store from which the promo rule will be deleted. |
Requirements
Output
json— Response from the API endpoint 'deleteEcommerceStoresIdPromorulesId'.MailchimpMarketingApi.DeleteSpecificSegment
Delete a specific segment from a Mailchimp list. Use this tool to delete a specific segment within a Mailchimp list by providing the list and segment IDs. This is useful for managing and organizing your email marketing lists.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
list_unique_id | string | Required | The unique ID for the Mailchimp list to target for segment deletion. |
segment_unique_id | string | Required | The unique identifier for the segment to be deleted. It must match the segment ID in Mailchimp. |
Requirements
Output
json— Response from the API endpoint 'deleteListsIdSegmentsId'.MailchimpMarketingApi.DeleteStoreCustomer
Delete a customer from an ecommerce store. Call this tool to remove a specific customer from a given ecommerce store. Use when you need to manage customer records by deleting them from a store's database.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
customer_identifier | string | Required | The unique identifier for the customer to be deleted from the store. This ID is used to specify which customer's records should be removed. |
store_identifier | string | Required | The unique identifier for the ecommerce store from which the customer will be deleted. |
Requirements
Output
json— Response from the API endpoint 'deleteEcommerceStoresIdCustomersId'.MailchimpMarketingApi.DeleteStorePromoCode
Delete a promo code from an e-commerce store. Use this tool to delete a specific promo code from a designated e-commerce store in Mailchimp Marketing. It is useful when you want to manage or clean up promotional offers by removing existing promo codes.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
promo_code_id | string | Required | The ID of the promo code to be deleted from the store. |
promo_rule_id | string | Required | The unique identifier for the promo rule of a store, used to specify which promo rule the code belongs to. |
store_identifier | string | Required | The unique identifier for the store from which the promo code will be deleted. |
Requirements
Output
json— Response from the API endpoint 'deleteEcommerceStoresIdPromocodesId'.MailchimpMarketingApi.DeleteTemplateFolder
Delete a specific template folder in Mailchimp. Use this tool to delete a specific template folder in Mailchimp and mark all its templates as 'unfiled'. Call this tool when you need to reorganize or clean up template folders.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
template_folder_id | string | Required | The unique ID for the template folder to be deleted. Use this to specify which folder should be removed and have its templates marked as 'unfiled'. |
Requirements
Output
json— Response from the API endpoint 'deleteTemplateFoldersId'.MailchimpMarketingApi.DeleteVerifiedDomain
Deletes a verified domain from your Mailchimp account. Use this tool to remove a domain that has been previously verified in your Mailchimp account. Ideal for situations where a domain is no longer needed or has ownership changes.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
domain_name | string | Required | The domain name to be deleted from your Mailchimp account. |
Requirements
Output
json— Response from the API endpoint 'deleteVerifiedDomain'.MailchimpMarketingApi.FetchAbuseReportDetails
Fetch details about a specific abuse report for a mailing list. This tool retrieves detailed information about an abuse report identified by a specific report ID associated with a mailing list via Mailchimp's marketing API. It should be called when specific details about an abuse report are needed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
abuse_report_id | string | Required | The unique identifier for the specific abuse report to fetch details for. |
mailing_list_unique_id | string | Required | The unique ID for the mailing list associated with the abuse report. |
fields_to_exclude | string | Optional | A comma-separated list of fields to exclude using dot notation for sub-objects. |
fields_to_return | string | Optional | A comma-separated list of fields to return. Use dot notation for sub-object parameters. |
pagination_offset | string | Optional | The number of records to skip for pagination. Default is 0. |
records_to_return | string | Optional | Specify the number of records to return, between 1 and 1000. Default is 10. |
Requirements
Output
json— Response from the API endpoint 'getListsIdAbuseReportsId'.MailchimpMarketingApi.FetchCampaignOpenLocations
Retrieve top open locations for a specific campaign. Use this tool to obtain the top geographical locations where a marketing campaign was opened. This can help in analyzing the reach and engagement of the campaign in different regions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
campaign_unique_id | string | Required | The unique identifier for the specific marketing campaign. |
fields_to_exclude | string | Optional | A comma-separated list of fields to exclude. Use dot notation for sub-objects. |
fields_to_return | string | Optional | A comma-separated list of fields to include in the response. Use dot notation for sub-objects. |
number_of_records | string | Optional | Specify the number of location records to return. Default is 10, maximum is 1000. |
records_to_skip | string | Optional | Number of records to skip for pagination purposes. Default is 0. |
Requirements
Output
json— Response from the API endpoint 'getReportsIdLocations'.MailchimpMarketingApi.FetchClickDetailsForCampaign
Retrieve details on members who clicked a specific campaign link. This tool retrieves information about list members who clicked on a specific link in an email marketing campaign. It should be called when you need insights into which members interacted with a particular link within a campaign.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
campaign_id | string | Required | A unique identifier for the email marketing campaign to retrieve click details. |
link_identifier | string | Required | The unique identifier for the specific link in the campaign. This ID is used to retrieve details of list members who clicked the link. |
exclude_fields_list | string | Optional | A comma-separated list of fields to exclude from the response. Use dot notation for sub-object parameters. |
fields_to_return | string | Optional | A comma-separated list of fields to include in the response. Use dot notation for nested fields. |
pagination_offset | string | Optional | The number of records to skip for pagination. Default is 0. |
record_count | string | Optional | The number of member records to return. Default is 10 and the maximum is 1000. |
Requirements
Output
json— Response from the API endpoint 'getReportsIdClickDetailsIdMembers'.MailchimpMarketingApi.ForgetContact
Forget a contact in the audience list. Use this tool to erase a contact's data from a specified audience in Mailchimp, ensuring the contact is forgotten.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
audience_id | string | Required | The unique ID for the audience where the contact should be forgotten. |
contact_id | string | Required | The unique ID of the contact to be forgotten from the audience. |
Requirements
Output
json— Response from the API endpoint 'postAudiencesContactsActionsForget'.MailchimpMarketingApi.GetAbuseReportsForList
Retrieve all abuse reports for a specified mailing list. Call this tool to get detailed information about abuse reports associated with a particular mailing list. This can be useful for monitoring and handling abuse feedback effectively.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
list_unique_id | string | Required | The unique ID for the mailing list to retrieve abuse reports for. |
exclude_fields_from_result | string | Optional | Comma-separated list of fields to exclude from the response, using dot notation for sub-objects. |
number_of_records_to_return | string | Optional | The number of records to return. Default is 10. Maximum is 1000. |
pagination_offset | string | Optional | Number of records to skip for pagination. Default is 0. |
return_fields | string | Optional | Comma-separated list of fields to include in the response. Use dot notation for sub-object parameters. |
Requirements
Output
json— Response from the API endpoint 'getListsIdAbuseReports'.MailchimpMarketingApi.GetAccountExportInfo
Get information about a specific account export. Use this tool to retrieve details about a particular account export using the export ID. Ideal for checking the status or details of exports in Mailchimp.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
account_export_id | string | Required | The unique ID for the account export. Required to retrieve specific export details. |
fields_to_exclude | string | Optional | A comma-separated list of fields to exclude. Use dot notation for sub-objects. |
include_fields | string | Optional | Comma-separated list of fields to include in the response, using dot notation for sub-objects. |
Requirements
Output
json— Response from the API endpoint 'getAccountExportId'.MailchimpMarketingApi.GetAccountOrders
Retrieve information about an account's ecommerce orders. Get details on all orders associated with a specific account, including order history and status.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
exclude_order_fields | string | Optional | Comma-separated list of fields to exclude, using dot notation for sub-objects. |
fields_to_return | string | Optional | Comma-separated list of fields to return. Use dot notation for sub-object parameters. |
filter_by_outreach_id | string | Optional | Return orders associated with the specified outreach_id. |
number_of_records_to_return | string | Optional | Specify the number of order records to return. Default is 10, maximum is 1000. |
pagination_offset | string | Optional | The number of records to skip for pagination. Default is 0. |
restrict_to_campaign_id | string | Optional | Restrict results to orders with a specific campaign ID value. |
restrict_to_outreach_orders | string | Optional | Restrict results to orders that have an outreach attached, such as an email campaign or Facebook ad. |
specific_customer_id | string | Optional | Restrict results to orders made by a specific customer using their unique customer ID. |
Requirements
Output
json— Response from the API endpoint 'getEcommerceOrders'.MailchimpMarketingApi.GetAllBatchWebhooks
Retrieve all configured webhooks for batches. Call this tool to get a list of webhooks that have been set up for handling batch processing events in Mailchimp.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
fields_to_exclude | string | Optional | Comma-separated list of fields to exclude. Use dot notation for sub-object parameters. |
fields_to_return | string | Optional | A comma-separated list of fields to return. Use dot notation for sub-object references. |
pagination_offset | string | Optional | Number of records to skip for pagination. Default is 0. |
records_to_return | string | Optional | Specify the number of webhook records to return. Default is 10, maximum is 1000. |
Requirements
Output
json— Response from the API endpoint 'getBatchWebhooks'.MailchimpMarketingApi.GetAllLandingPages
Retrieve all landing pages from Mailchimp. Use this tool to obtain a comprehensive list of all landing pages available in your Mailchimp account. Useful for marketing analysis and content management.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
exclude_fields_list | string | Optional | A comma-separated list of fields to exclude using dot notation for sub-objects. |
include_fields | string | Optional | Comma-separated list of fields to include in the response, using dot notation for nested fields. |
record_count | string | Optional | Specify the number of landing page records to return. Defaults to 10; maximum is 1000. |
sort_by_field | string | Optional | Specify the field by which the landing pages should be sorted. |
sort_direction | string | Optional | Specifies the order direction for sorting the results (e.g., ascending or descending). |
Requirements
Output
json— Response from the API endpoint 'getAllLandingPages'.MailchimpMarketingApi.GetAllMarketingCampaigns
Fetches all marketing campaigns from an account. Use this tool to retrieve a list of all marketing campaigns associated with a Mailchimp account.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
campaign_status | string | Optional | Filter campaigns by their status (e.g., sent, draft). |
campaign_type | string | Optional | Specify the type of campaign to retrieve (e.g., regular, plaintext, absplit). |
campaigns_created_after | string | Optional | Specify the date and time to restrict results to campaigns created after this point. Must be in ISO 8601 format. |
created_before_date_time | string | Optional | Restrict response to campaigns created before this time using ISO 8601 format. |
exclude_fields | string | Optional | A comma-separated list of fields to exclude from the response. Use dot notation for sub-object parameters. |
fields_to_return | string | Optional | Comma-separated list of fields to return. Use dot notation for sub-object parameters. |
include_resend_shortcut_eligibility | string | Optional | Include this field in the response to determine if campaigns are eligible for Resend Shortcuts. |
list_member_identifier | string | Optional | The MD5 hash of the lowercase version of the list member’s email. Used to retrieve campaigns sent to this member. |
list_unique_id | string | Optional | The unique identifier for the list associated with the campaigns to be retrieved. |
number_of_records_to_return | string | Optional | Number of records to return, between 10 and 1000. Default is 10. |
pagination_offset | string | Optional | The number of records to skip for pagination. Default is 0. |
restrict_to_campaigns_sent_after | string | Optional | Restrict the response to campaigns sent after the specified ISO 8601 time. |
sent_before_time | string | Optional | Restricts the response to campaigns sent before the specified time. It should be in ISO 8601 format. |
sort_by_field | string | Optional | Specify the field to sort the campaigns by. Use dot notation for sub-object fields. |
sort_order_direction | string | Optional | Specify the sorting order for the results. Use 'ASC' for ascending or 'DESC' for descending. |
unique_folder_id | string | Optional | Unique identifier for the folder containing the campaigns. |
Requirements
Output
json— Response from the API endpoint 'getCampaigns'.MailchimpMarketingApi.GetAudienceContacts
Retrieve all audience information from the account. Use this tool to get detailed information about every audience in the Mailchimp account, assisting in data management and marketing analysis.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
exclude_fields_list | string | Optional | A comma-separated list of fields to exclude from the response. Use dot notation for sub-object parameters. |
include_fields | string | Optional | A comma-separated list of fields to return. Use dot notation for sub-object parameters. |
pagination_offset | string | Optional | The number of records to skip for pagination. Default is 0. |
records_to_return | string | Optional | The number of audience records to return, ranging from 1 to 1000. Default is 10. |
Requirements
Output
json— Response from the API endpoint 'getAudienceContacts'.MailchimpMarketingApi.GetAudienceInfo
Retrieve information about a specific audience. Use this tool to get details about a specific audience in Mailchimp Marketing using the audience ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
audience_id | string | Required | The unique ID of the audience to retrieve information for. |
exclude_fields_list | string | Optional | A list of fields to exclude from the response, using dot notation for sub-objects. |
fields_to_return | string | Optional | A comma-separated list of fields to return. Use dot notation for sub-object parameters. |
Requirements
Output
json— Response from the API endpoint 'getAudienceId'.MailchimpMarketingApi.GetAudienceMergeFields
Get a list of all merge fields for an audience. Use this tool to retrieve all the merge fields associated with a specific audience in Mailchimp. This is useful for understanding the structure and data fields available within an audience.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
audience_list_id | string | Required | The unique ID for the audience list in Mailchimp. |
exclude_fields_list | string | Optional | A comma-separated list of fields to exclude from the response. Use dot notation for sub-object fields. |
fields_to_return | string | Optional | Comma-separated list of fields to return, using dot notation for sub-objects. |
is_required_merge_field | string | Optional | Indicates if the merge field is required. Pass 'true' or 'false'. |
merge_field_type | string | Optional | Specify the type of merge field to retrieve, such as 'text', 'number', etc. |
number_of_records_to_return | string | Optional | Specify the number of records to return, between 1 and 1000 (default is 10). |
pagination_offset | string | Optional | The number of records to skip for pagination. Default is 0. |
Requirements
Output
json— Response from the API endpoint 'getListsIdMergeFields'.MailchimpMarketingApi.GetAuthorizedAppInfo
Retrieve details of a specific authorized application. This tool retrieves information about a specific authorized application using the app ID. It is useful for checking the details or status of an application authorized within Mailchimp.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
authorized_application_id | string | Required | The unique ID for the connected authorized application to retrieve its information. |
fields_to_exclude | string | Optional | Comma-separated list of fields to exclude. Use dot notation for sub-object references. |
fields_to_return | string | Optional | A comma-separated list of fields to return. Use dot notation for sub-object parameters. |
Requirements
Output
json— Response from the API endpoint 'getAuthorizedAppsId'.MailchimpMarketingApi.GetAutomationEmailInfo
Retrieve details of a specific classic automation email. Use this tool to get detailed information about a specific email within a classic automation workflow in Mailchimp Marketing.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
automation_email_unique_id | string | Required | The unique identifier for the Automation workflow email in Mailchimp. |
automation_workflow_id | string | Required | The unique ID for the automation workflow. |
Requirements
Output
json— Response from the API endpoint 'getAutomationsIdEmailsId'.MailchimpMarketingApi.GetAutomationEmailQueueInfo
Retrieve details of a classic automation email queue in Mailchimp. This tool retrieves information about a classic automation email queue in Mailchimp. It should be called when you need details about queued emails for a specific automation workflow and email.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
automation_workflow_email_id | string | Required | The unique ID for the automation workflow email. |
automation_workflow_id | string | Required | The unique ID for the Automation workflow to obtain the email queue details. |
Requirements
Output
json— Response from the API endpoint 'getAutomationsIdEmailsIdQueue'.MailchimpMarketingApi.GetAutomationEmailsSummary
Get a summary of emails in an automation workflow. Use this tool to retrieve a summary of all emails within a specified classic automation workflow. Call this tool when you need detailed insights into the automation process.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
automation_workflow_id | string | Required | The unique ID of the automation workflow to retrieve the email summary for. |
Requirements
Output
json— Response from the API endpoint 'getAutomationsIdEmails'.MailchimpMarketingApi.GetAutomationSubscriberInfo
Get details of a subscriber in an automation email queue. This tool retrieves information about a specific subscriber within the queue of a classic automation email in Mailchimp. Use this when you need to access details about how a subscriber is queued in a specific workflow email.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
automation_workflow_email_id | string | Required | The unique ID for the Automation workflow email in Mailchimp. |
automation_workflow_id | string | Required | The unique ID for the Automation workflow in Mailchimp. |
subscriber_email_md5_hash | string | Required | The MD5 hash of the lowercase version of the subscriber's email address in the list. |
Requirements
Output
json— Response from the API endpoint 'getAutomationsIdEmailsIdQueueId'.MailchimpMarketingApi.GetAutomationSummary
Retrieve details of a specific classic automation workflow. This tool fetches a summary of an individual classic automation workflow's settings and content, including trigger settings for the first email.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
workflow_id | string | Required | The unique ID for the automation workflow to retrieve its summary. |
fields_to_exclude | string | Optional | A comma-separated list of fields to exclude from the automation workflow details. Use dot notation for sub-objects. |
include_fields | string | Optional | A comma-separated list of fields to include in the response. Use dot notation for sub-object parameters. |
Requirements
Output
json— Response from the API endpoint 'getAutomationsId'.MailchimpMarketingApi.GetAvailableTemplates
Retrieve a list of available email templates. Fetches and returns a list of all the email templates available in a Mailchimp account. Useful for managing and selecting templates for campaigns.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
created_after_date | string | Optional | Retrieve templates created after a specific date. Use ISO 8601 format (e.g., 2015-10-21T15:41:36+00:00). |
exclude_fields_list | string | Optional | Comma-separated fields to exclude from the response, using dot notation for sub-objects. |
fields_to_return | string | Optional | Comma-separated list of fields to include in the response, using dot notation for sub-objects. |
filter_by_category | string | Optional | Limit the results to templates that match a specific category. |
number_of_records_to_return | string | Optional | Specify the number of template records to return (1-1000). Default is 10. |
pagination_offset | string | Optional | Number of records to skip for pagination. Default is 0. Use for paginated responses. |
restrict_before_date_created | string | Optional | Restrict the response to templates created before the specified date in ISO 8601 format. For example: 2015-10-21T15:41:36+00:00. |
sort_order_direction | string | Optional | Specify the order direction for sorted results ('asc' for ascending, 'desc' for descending). |
sort_templates_by_field | string | Optional | Specify the field to sort templates by. Determines the sorting order of returned templates. |
template_content_type | string | Optional | Filter templates based on content structure. Use 'template' for legacy, 'multichannel' for new editor, or 'html' for code your own. |
template_creator_user | string | Optional | Specify the Mailchimp account user who created the template to filter results. |
template_folder_id | string | Optional | The unique ID for the folder containing templates to retrieve. |
template_type | string | Optional | Specify the template type to limit the results. This filters the email templates based on their type. |
Requirements
Output
json— Response from the API endpoint 'getTemplates'.MailchimpMarketingApi.GetBatchStatus
Retrieve the status of a Mailchimp batch request. Use this tool to check the current status of a specific batch request in Mailchimp, identified by its batch ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
batch_operation_id | string | Required | The unique ID for the Mailchimp batch operation to check its status. |
excluded_fields_list | string | Optional | Comma-separated list of fields to exclude from the response. Use dot notation for sub-object parameters. |
return_fields | string | Optional | A comma-separated list of fields to include in the response, using dot notation for sub-objects. |
Requirements
Output
json— Response from the API endpoint 'getBatchesId'.MailchimpMarketingApi.GetBatchSummaries
Retrieve a summary of batch requests from Mailchimp. Call this tool to obtain a summary of batch requests that have been executed in Mailchimp. Useful for monitoring and tracking the status and details of past batch operations.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
exclude_fields_to_return | string | Optional | A comma-separated list of fields to exclude from the response. Use dot notation for sub-objects. |
fields_to_return | string | Optional | A comma-separated list of specific fields to include in the response, using dot notation for sub-objects. |
pagination_offset | string | Optional | Number of records to skip for pagination. Default is 0, used for navigating through large sets of data. |
record_count_to_return | string | Optional | Specify the number of records to return, from 1 to 1000. Default is 10. |
Requirements
Output
json— Response from the API endpoint 'getBatches'.MailchimpMarketingApi.GetBatchWebhookInfo
Retrieve details of a specific batch webhook on Mailchimp. Use this tool to get information about a specific batch webhook in a Mailchimp account. It retrieves details such as status and metadata of the specified webhook.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
batch_webhook_id | string | Required | The unique ID for the batch webhook to retrieve information from Mailchimp. |
fields_to_exclude | string | Optional | A comma-separated list of fields to exclude from the batch webhook details. Use dot notation for sub-objects. |
include_fields | string | Optional | Specify fields to include in response. Use dot notation for sub-object fields. |
Requirements
Output
json— Response from the API endpoint 'getBatchWebhook'.MailchimpMarketingApi.GetCampaignAbuseReportDetails
Retrieve details of an abuse report for a campaign. Use this tool to get information about a specific abuse report related to a campaign. It should be called when detailed information about an abuse report is required for analysis or record-keeping.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
abuse_report_id | string | Required | The unique identifier for the abuse report. This ID is necessary to retrieve the specific report details. |
campaign_unique_id | string | Required | The unique identifier for the campaign to fetch the abuse report details. |
exclude_fields_list | string | Optional | A comma-separated list of fields to exclude from the response. Use dot notation for sub-objects. |
include_fields | string | Optional | A comma-separated list of fields to include in the response, using dot notation for sub-objects. |
Requirements
Output
json— Response from the API endpoint 'getReportsIdAbuseReportsIdId'.MailchimpMarketingApi.GetCampaignAbuseReports
Get a list of abuse complaints for a specific campaign. Call this tool to retrieve and review all abuse complaints related to a particular email marketing campaign. Useful for tracking and managing issues with campaign recipients reporting spam or other abuses.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
campaign_unique_id | string | Required | The unique identifier for the email marketing campaign to fetch abuse complaints. |
exclude_fields | string | Optional | Comma-separated list of fields to exclude in the response using dot notation for sub-objects. |
include_fields | string | Optional | A comma-separated list of fields to include in the response. Use dot notation for nested fields. |
Requirements
Output
json— Response from the API endpoint 'getReportsIdAbuseReportsId'.MailchimpMarketingApi.GetCampaignAdviceFeedback
Get feedback based on a campaign's performance data. This tool provides advice and feedback derived from various campaign statistics, such as open rates, click-through rates, unsubscribes, and bounces. Use it to gain insights into campaign effectiveness and areas for improvement.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
campaign_id | string | Required | The unique identifier for the campaign to get advice feedback on. |
exclude_fields_to_return | string | Optional | A comma-separated list of fields to omit in the response. Use dot notation for sub-objects. |
include_fields | string | Optional | Comma-separated fields to include in the response. Use dot notation for sub-objects. |
Requirements
Output
json— Response from the API endpoint 'getReportsIdAdvice'.MailchimpMarketingApi.GetCampaignClickDetails
Get details about link clicks in Mailchimp campaigns. Use this tool to obtain detailed information about clicks on specific links in your Mailchimp marketing campaigns. It helps analyze the engagement by providing insights into which links were clicked and how often.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
campaign_unique_id | string | Required | The unique identifier for a specific Mailchimp campaign. Required to fetch corresponding click details. |
fields_to_exclude | string | Optional | Comma-separated list of fields to exclude using dot notation for sub-objects. |
number_of_records_to_return | string | Optional | Specify the number of click records to return. The default is 10, and the maximum is 1000. |
pagination_offset | string | Optional | Number of records to skip for pagination. Default is 0. |
return_fields | string | Optional | A comma-separated list of fields to include in the response. Use dot notation for sub-objects. |
sort_by_field | string | Optional | Specify the field to sort click reports by, such as 'clicks', 'unique_clicks', or 'link_name'. |
sort_direction | string | Optional | Determines the order direction for sorted results, such as ascending or descending. |
Requirements
Output
json— Response from the API endpoint 'getReportsIdClickDetails'.MailchimpMarketingApi.GetCampaignContent
Retrieve the HTML and plain-text content for a Mailchimp campaign. Use this tool to get the content of a specific Mailchimp campaign by providing its campaign ID. The response includes both HTML and plain-text content, useful for viewing or analyzing email campaigns in detail.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
campaign_id | string | Required | The unique identifier for the Mailchimp campaign to retrieve content for. |
exclude_fields_list | string | Optional | A comma-separated list of fields to exclude when retrieving campaign content. Use dot notation for sub-object fields. |
included_fields | string | Optional | A comma-separated list of fields to include in the response. Use dot notation to specify sub-object parameters. |
Requirements
Output
json— Response from the API endpoint 'getCampaignsIdContent'.MailchimpMarketingApi.GetCampaignDetails
Retrieve details of a specific marketing campaign. Use this tool to get detailed information about a specific campaign using its ID. It provides insights and data related to that campaign.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
campaign_id | string | Required | The unique identifier for the campaign to retrieve details about. |
fields_to_exclude | string | Optional | A comma-separated list of fields to exclude, using dot notation for sub-objects. |
fields_to_return | string | Optional | Specify a comma-separated list of fields to return, using dot notation for sub-object parameters. |
include_resend_shortcut_eligibility | string | Optional | Include the `resend_shortcut_eligibility` field in the response to check if the campaign is eligible for Campaign Resend Shortcuts. |
include_resend_shortcut_usage | string | Optional | Include this to receive the `resend_shortcut_usage` field, providing details about campaigns related by a shortcut. |
Requirements
Output
json— Response from the API endpoint 'getCampaignsId'.MailchimpMarketingApi.GetCampaignDomainPerformance
Get top domain performance for an email campaign. Retrieve statistics on how email domains have performed in a specific campaign using the campaign ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
campaign_unique_id | string | Required | The unique identifier for the email campaign to retrieve domain performance statistics. |
exclude_fields_from_report | string | Optional | Comma-separated list of fields to exclude from the report, using dot notation for sub-objects. |
fields_to_return | string | Optional | A comma-separated list of fields to return in the response. Use dot notation for sub-object parameters. |
Requirements
Output
json— Response from the API endpoint 'getReportsIdDomainPerformance'.MailchimpMarketingApi.GetCampaignEmailActivity
Retrieve specific list member's activity in a campaign. Get detailed information on a list member's activity in a campaign, including opens, clicks, and bounces, by providing the campaign ID and subscriber hash.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
campaign_unique_id | string | Required | The unique identifier for the campaign whose member activity is being retrieved. |
subscriber_hash | string | Required | The MD5 hash of the lowercase version of the list member's email address for which you want to retrieve activity. |
fields_to_exclude | string | Optional | A comma-separated list of fields to exclude from the response using dot notation for sub-objects. |
fields_to_return | string | Optional | Comma-separated list of fields to return, using dot notation for sub-objects. |
restrict_activity_since | string | Optional | Restrict results to email activity events occurring after this time (ISO 8601 format). |
Requirements
Output
json— Response from the API endpoint 'getReportsIdEmailActivityId'.MailchimpMarketingApi.GetCampaignFeedbackMessage
Retrieve a specific feedback message from a campaign. Use this tool to get detailed feedback from a specific campaign by providing the campaign and feedback identifiers.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
campaign_unique_id | string | Required | The unique identifier for the campaign to retrieve the specific feedback message. |
feedback_message_id | string | Required | The unique identifier for the feedback message to retrieve from the campaign. |
exclude_fields_from_feedback | string | Optional | A comma-separated list of fields to exclude from the feedback. Use dot notation for sub-object parameters. |
fields_to_return | string | Optional | A comma-separated list of fields to include in the response. Use dot notation for sub-object fields. |
Requirements
Output
json— Response from the API endpoint 'getCampaignsIdFeedbackId'.MailchimpMarketingApi.GetCampaignFolderInfo
Get details about a specific campaign folder. Call this tool to retrieve information about a specific campaign folder used for organizing campaigns in Mailchimp.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
campaign_folder_id | string | Required | The unique identifier for the campaign folder. Used to specify which folder's information to retrieve. |
exclude_fields | string | Optional | Specify a comma-separated list of fields to exclude from the response. Use dot notation for sub-object parameters. |
included_fields | string | Optional | Comma-separated list of fields to return. Use dot notation for sub-object parameters. |
Requirements
Output
json— Response from the API endpoint 'getCampaignFoldersId'.MailchimpMarketingApi.GetCampaignFolders
Retrieve all folders used to organize campaigns. Use this tool to get a list of all folders created for organizing your campaigns in Mailchimp.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
exclude_fields | string | Optional | A comma-separated list of fields to exclude. Use dot notation for sub-objects. |
include_fields | string | Optional | A comma-separated list of fields to include in the response. Use dot notation for sub-object fields. |
number_of_records_to_return | string | Optional | The number of campaign folders to return, between 1 and 1000. Defaults to 10. |
pagination_offset | string | Optional | Number of records to skip for pagination. Defaults to 0. Use for fetching subsequent pages. |
Requirements
Output
json— Response from the API endpoint 'getCampaignFolders'.MailchimpMarketingApi.GetCampaignLinkClickDetails
Get click details for a specific campaign link. Fetch detailed click information for a specific link within a Mailchimp campaign report. Useful for analyzing link engagement.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
campaign_unique_id | string | Required | The unique identifier for the Mailchimp campaign to fetch link click details. |
link_identifier | string | Required | The unique identifier for the link whose click details are to be retrieved in the campaign report. |
excluded_fields_list | string | Optional | A comma-separated list of fields to exclude from the response, using dot notation for sub-objects. |
include_fields | string | Optional | A comma-separated list of fields to return. Use dot notation for sub-objects. |
Requirements
Output
json— Response from the API endpoint 'getReportsIdClickDetailsId'.MailchimpMarketingApi.GetCampaignOpenDetails
Get details on opened campaign emails by list members. Use this tool to retrieve detailed information about emails from a specific campaign that were opened by list members. Ideal for understanding engagement and assessing campaign performance.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
campaign_unique_id | string | Required | The unique identifier for the campaign. Required to retrieve open details for specific campaign emails. |
exclude_fields_to_return | string | Optional | Comma-separated fields to exclude from the response. Use dot notation for sub-objects. |
fields_to_return | string | Optional | A comma-separated list of fields to return, using dot notation for sub-objects. |
number_of_records_to_return | string | Optional | Specify the number of records to return. Default is 10, maximum is 1000. |
pagination_offset | string | Optional | The number of records from the collection to skip for pagination. Default is 0. |
sort_by_field | string | Optional | Specify the field by which to sort the open reports. Choose from available fields to determine the order of results. |
sort_order_direction | string | Optional | Specify the order direction for sorted results. Use 'asc' for ascending or 'desc' for descending. |
start_date_time_for_campaign_open_events | string | Optional | Restrict results to campaign open events that occur after this date and time in ISO 8601 format (e.g., 2015-10-21T15:41:36+00:00). |
Requirements
Output
json— Response from the API endpoint 'getReportsIdOpenDetails'.MailchimpMarketingApi.GetCampaignProductActivity
Get breakdown of product activity for a campaign. This tool retrieves the breakdown of product activity related to a specific marketing campaign from Mailchimp. It should be called when detailed ecommerce product performance data for a campaign is needed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
campaign_unique_id | string | Required | The unique identifier for the campaign whose product activity is being retrieved. |
exclude_fields_from_response | string | Optional | A comma-separated list of fields to exclude from the response. Use dot notation for sub-objects. |
include_fields | string | Optional | Comma-separated list of fields to return, using dot notation for sub-objects. |
number_of_records_to_return | string | Optional | The number of records to return, between 1 and 1000. Defaults to 10. |
pagination_offset | string | Optional | Number of records to skip for pagination. Default is 0. |
sort_results_by_field | string | Optional | Specify the field by which to sort the product activity results. Use dot notation for sub-object fields. |
Requirements
Output
json— Response from the API endpoint 'getReportsIdEcommerceProductActivity'.MailchimpMarketingApi.GetCampaignRecipientInfo
Get information about a specific campaign recipient. Use this tool to retrieve details about a particular recipient of a Mailchimp marketing campaign. Provide the campaign ID and subscriber hash to access the information.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
campaign_unique_id | string | Required | The unique ID for the campaign for which recipient information is requested. It should be in string format and is required to identify the specific campaign. |
recipient_subscriber_hash | string | Required | MD5 hash of the lowercase version of the recipient's email address. |
excluded_fields | string | Optional | A comma-separated list of fields to exclude. Use dot notation for sub-object parameters. |
fields_to_return | string | Optional | Comma-separated fields to include in the response, using dot notation for sub-objects. |
Requirements
Output
json— Response from the API endpoint 'getReportsIdSentToId'.MailchimpMarketingApi.GetCampaignRecipients
Retrieve information about campaign recipients. Use this tool to obtain detailed information about recipients of a specific marketing campaign. It provides insights into who received the campaign.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
campaign_unique_identifier | string | Required | The unique identifier for the specific campaign whose recipients you want to retrieve. |
fields_to_exclude | string | Optional | A comma-separated list of fields to exclude, using dot notation for sub-objects. |
include_fields | string | Optional | Comma-separated list of fields to return, using dot notation for sub-objects. |
number_of_records_to_return | string | Optional | Specify the number of recipient records to return, between 1 and 1000. Default is 10. |
pagination_offset | string | Optional | Number of records to skip for pagination. Default is 0. |
Requirements
Output
json— Response from the API endpoint 'getReportsIdSentTo'.MailchimpMarketingApi.GetCampaignReportDetails
Retrieve detailed report for a specific sent campaign. Use this tool to access the report details of a specific campaign that has been sent. It provides insights and metrics for evaluating the campaign's performance.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
campaign_unique_id | string | Required | The unique ID for the campaign to retrieve its report details. |
exclude_fields_list | string | Optional | Comma-separated list of fields to be excluded from the response. Use dot notation for sub-object references. |
fields_to_return | string | Optional | Comma-separated list of fields to return. Use dot notation for sub-objects. |
Requirements
Output
json— Response from the API endpoint 'getReportsId'.MailchimpMarketingApi.GetCampaignReports
Retrieve detailed campaign reports from Mailchimp. This tool retrieves campaign performance reports from Mailchimp Marketing. It should be called when detailed analytics about email campaigns are needed, such as open rates, click rates, and other metrics.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
campaign_type | string | Optional | Specify the type of campaign to retrieve reports for. Valid options are dependent on Mailchimp's supported campaign types. |
exclude_fields_list | string | Optional | A comma-separated list of fields to exclude from the report. Use dot notation for sub-objects. |
included_fields | string | Optional | Comma-separated list of fields to include in the response, using dot notation for sub-objects. |
number_of_records_to_return | string | Optional | Specify the number of records to return, ranging from 10 to 1000. Default is 10. |
pagination_offset | string | Optional | The number of records to skip for pagination. Default is 0. |
restrict_to_campaigns_sent_after | string | Optional | Restrict the response to campaigns sent after the specified ISO 8601 date and time. |
restrict_to_campaigns_sent_before | string | Optional | Restrict response to campaigns sent before this ISO 8601 time format (e.g., 2015-10-21T15:41:36+00:00). |
Requirements
Output
json— Response from the API endpoint 'getReports'.MailchimpMarketingApi.GetCampaignSocialActivity
Get social activity summary for a campaign using EepURL. Use this tool to retrieve a summary of social activity tracked by EepURL for a specific campaign in Mailchimp.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
campaign_unique_id | string | Required | The unique id for the campaign to retrieve its social activity summary. |
fields_to_exclude | string | Optional | Comma-separated list of fields to exclude from the response. Use dot notation for sub-objects. |
fields_to_return | string | Optional | A comma-separated list of fields to include in the response, using dot notation for sub-object parameters. |
Requirements
Output
json— Response from the API endpoint 'getReportsIdEepurl'.MailchimpMarketingApi.GetCampaignSubReports
Retrieve sub-reports of a specific parent campaign. Use this tool to get the reports of child campaigns associated with a particular parent campaign in Mailchimp. Useful for analyzing the performance of linked campaigns.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
campaign_unique_id | string | Required | The unique ID of the parent campaign to retrieve sub-reports for. |
fields_to_exclude | string | Optional | A comma-separated list of fields to exclude. Use dot notation for sub-object parameters. |
return_fields | string | Optional | Comma-separated list of fields to return, using dot notation for sub-objects. |
Requirements
Output
json— Response from the API endpoint 'getReportsIdSubReportsId'.MailchimpMarketingApi.GetCampaignSubscriberOpenDetails
Retrieve details of a subscriber who opened a campaign. This tool fetches information about a specific subscriber who opened a given email campaign. It is useful for tracking engagement and understanding subscriber behavior in email marketing campaigns.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
campaign_unique_id | string | Required | The unique identifier for the campaign to retrieve subscriber open details. |
subscriber_email_hash | string | Required | The MD5 hash of the lowercase version of the subscriber's email address. |
exclude_fields_from_response | string | Optional | A comma-separated list of fields to exclude from the response, using dot notation for sub-objects. |
fields_to_return | string | Optional | A comma-separated list of fields to return for the subscriber's open details. Use dot notation for sub-object fields. |
Requirements
Output
json— Response from the API endpoint 'getReportsIdOpenDetailsIdMembersId'.MailchimpMarketingApi.GetCartInfo
Fetch information about a specific ecommerce cart. Use this tool to retrieve detailed information about a specific cart in an ecommerce store. It's useful for scenarios where you need to understand the contents or status of a cart identified by store and cart IDs.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
cart_identifier | string | Required | The unique identifier for the cart in the ecommerce store. |
store_identifier | string | Required | The unique identifier for the store. Use this to specify which store's cart information to retrieve. |
fields_to_exclude | string | Optional | Comma-separated list of fields to exclude using dot notation for nested objects. |
include_fields | string | Optional | Specify a comma-separated list of fields to return, using dot notation for sub-objects. |
Requirements
Output
json— Response from the API endpoint 'getEcommerceStoresIdCartsId'.MailchimpMarketingApi.GetCartLineItemsInfo
Retrieve information about a cart's line items. Use this tool to get details about the items in a specific cart within an ecommerce store. It provides insights into products added to a cart.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
cart_id | string | Required | The unique identifier for the cart to retrieve line items for. |
store_identifier | string | Required | The unique identifier for the store containing the cart. |
exclude_fields | string | Optional | Specify fields to exclude from the response. Use a comma-separated list with dot notation for sub-object parameters. |
fields_to_return | string | Optional | A comma-separated list of fields to return in the response. Use dot notation for sub-object parameters. |
pagination_offset | string | Optional | Number of records to skip for pagination. Defaults to 0. |
records_to_return | string | Optional | The number of cart line items to return, from 1 to 1000. Default is 10. |
Requirements
Output
json— Response from the API endpoint 'getEcommerceStoresIdCartsIdLines'.MailchimpMarketingApi.GetChimpChatterActivity
Retrieve the latest Chimp Chatter activity for your account. Use this tool to fetch the most recent Chimp Chatter activity feed from your Mailchimp account. This provides updates ordered by the latest first.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
number_of_records_to_return | string | Optional | Specify the number of Chimp Chatter records to return. Default is 10, maximum is 1000. |
pagination_offset | string | Optional | Number of records to skip for pagination. Default is 0. |
Requirements
Output
json— Response from the API endpoint 'getActivityFeedChimpChatter'.MailchimpMarketingApi.GetClassicAutomationsSummary
Fetch a summary of an account's classic automations. Call this tool to obtain a summary of classic automations set up in a Mailchimp account, useful for understanding automation configurations and statuses.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
automation_status_filter | string | Optional | Specify the status of automations to filter results (e.g., 'active', 'paused'). |
created_after_time | string | Optional | Specify the time to filter automations created after this date-time. Use ISO 8601 format, e.g., 2015-10-21T15:41:36+00:00. |
exclude_fields_list | string | Optional | A comma-separated list of fields to exclude. Use dot notation for sub-objects. |
fields_to_return | string | Optional | Comma-separated list of fields to include in the response, using dot notation for sub-objects. |
number_of_records_to_return | string | Optional | The number of automation records to return. Default is 10, maximum is 1000. |
pagination_offset | string | Optional | Number of records to skip for pagination. Default is 0. |
restrict_before_create_time | string | Optional | Restrict the response to automations created before the specified time in ISO 8601 format. Example: 2015-10-21T15:41:36+00:00. |
restrict_to_automations_started_before | string | Optional | Restrict the response to automations started before this time using ISO 8601 format (e.g., 2015-10-21T15:41:36+00:00). |
start_time_after | string | Optional | Restrict the response to automations started after this date and time in ISO 8601 format (e.g., 2015-10-21T15:41:36+00:00). |
Requirements
Output
json— Response from the API endpoint 'getAutomations'.MailchimpMarketingApi.GetConnectedApps
Retrieve registered connected applications for an account. Use this tool to get a list of applications that are registered and connected to a Mailchimp account.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
exclude_fields_from_response | string | Optional | A comma-separated list of fields to exclude from the response, referencing sub-objects with dot notation. |
fields_to_return | string | Optional | A comma-separated list of fields to return in the response. Use dot notation for sub-object fields. |
number_of_records_to_return | string | Optional | Specify the number of records to return. Default is 10, maximum is 1000. |
pagination_offset | string | Optional | Number of records to skip for pagination. Default is 0. |
Requirements
Output
json— Response from the API endpoint 'getAuthorizedApps'.MailchimpMarketingApi.GetConnectedSiteInfo
Retrieve details of a specific connected site. Use this tool to get information about a connected site using its ID. It provides various details related to the site.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
connected_site_identifier | string | Required | The unique identifier for the connected site to retrieve its information. |
exclude_fields_list | string | Optional | A comma-separated list of fields to exclude from the response. Use dot notation for sub-objects. |
fields_to_return | string | Optional | Specify a comma-separated list of fields to return. Use dot notation for sub-object parameters. |
Requirements
Output
json— Response from the API endpoint 'getConnectedSitesId'.MailchimpMarketingApi.GetConnectedSites
Retrieve all connected sites from a Mailchimp account. Use this tool to get a list of all sites connected to a Mailchimp account. Ideal for managing or reviewing the connected site configurations.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
exclude_fields_list | string | Optional | A list of fields to exclude, using dot notation for sub-object parameters. |
included_fields | string | Optional | A comma-separated list of specific fields to return. Use dot notation for sub-object parameters. |
number_of_records_to_return | string | Optional | The number of records to return. Default is 10, maximum is 1000. |
pagination_offset | string | Optional | Number of records to skip for pagination. Default is 0. |
Requirements
Output
json— Response from the API endpoint 'getConnectedSites'.MailchimpMarketingApi.GetCustomerInfo
Retrieve specific customer information from an eCommerce store. Use this tool to get detailed information about a specific customer from an eCommerce store using their customer ID and store ID. Ideal for checking customer profiles, transaction histories, and personal information tied to their account.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
customer_id | string | Required | The unique identifier for a customer in a specific store. Required to fetch customer details. |
store_id | string | Required | The unique identifier for the eCommerce store. |
fields_to_exclude | string | Optional | Comma-separated list of fields to exclude using dot notation for sub-objects. |
return_fields | string | Optional | A comma-separated list of fields to return for the customer data. Use dot notation for sub-objects. |
Requirements
Output
json— Response from the API endpoint 'getEcommerceStoresIdCustomersId'.MailchimpMarketingApi.GetDailyListActivity
Fetch daily detailed activity stats for a list in Mailchimp. Retrieve up to the previous 180 days of aggregated daily activity statistics for a specific list, excluding Automation activity.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
list_unique_id | string | Required | The unique identifier for the Mailchimp list to retrieve activity stats. |
exclude_fields | string | Optional | Comma-separated list of fields to exclude. Use dot notation for sub-object parameters. |
include_fields | string | Optional | Comma-separated list of specific fields to include in the response, using dot notation for sub-objects. |
number_of_records_to_return | string | Optional | The number of records to return. Default is 10, maximum is 1000. |
pagination_offset | string | Optional | The number of records to skip for pagination. Default is 0. |
Requirements
Output
json— Response from the API endpoint 'getListsIdActivity'.MailchimpMarketingApi.GetDomainDetails
Retrieve details for a specific verified domain. Use this tool to get the details of a single verified domain on your Mailchimp account. Useful for accessing domain-specific information.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
domain_name | string | Required | The domain name to retrieve details for. Must be a verified domain on the account. |
Requirements
Output
json— Response from the API endpoint 'getVerifiedDomain'.MailchimpMarketingApi.GetEcommerceStoreInfo
Retrieve detailed information about a specific eCommerce store. Use this tool to get detailed information about a specific store in Mailchimp's eCommerce service. Call this when you need to access store data, such as name, domain, or other relevant attributes.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
store_id | string | Required | A unique identifier for the store to retrieve information about. |
excluded_fields_list | string | Optional | Comma-separated list of fields to exclude from the response, using dot notation for sub-objects. |
fields_to_return | string | Optional | A comma-separated list of fields to return. Use dot notation for sub-object parameters. |
Requirements
Output
json— Response from the API endpoint 'getEcommerceStoresId'.MailchimpMarketingApi.GetEcommerceStoresInfo
Retrieve information about all ecommerce stores in the account. This tool fetches details of all ecommerce stores linked to the account, enabling insights into store data.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
exclude_fields_list | string | Optional | A comma-separated list of fields to exclude from the response, using dot notation for nested objects. |
fields_to_return | string | Optional | Comma-separated list of fields to return using dot notation for sub-objects. |
pagination_offset | string | Optional | The number of records to skip for pagination. Default is 0. |
records_to_return | string | Optional | Specify the number of store records to return (10 to 1000). |
Requirements
Output
json— Response from the API endpoint 'getEcommerceStores'.MailchimpMarketingApi.GetFacebookAdDetails
Retrieve details of a specific Facebook ad campaign. Use this tool to fetch detailed information about a specific Facebook ad by providing its outreach ID. This can be helpful for tracking ad performance or reviewing campaign specifics.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
facebook_ad_outreach_id | string | Required | The unique outreach ID of the Facebook ad to retrieve details for. |
exclude_fields_list | string | Optional | A comma-separated list of fields to exclude using dot notation for sub-objects. |
fields_to_return | string | Optional | Comma-separated list of fields to return; use dot notation for sub-object parameters. |
Requirements
Output
json— Response from the API endpoint 'getFacebookAdsId'.MailchimpMarketingApi.GetFacebookAdReport
Get report details of a Facebook ad campaign. Use this tool to retrieve detailed reports of a specific Facebook advertisement managed through Mailchimp. This is useful for analyzing ad performance and outreach impact.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
outreach_id | string | Required | The unique identifier for the Facebook ad campaign to retrieve the report for. |
fields_to_exclude | string | Optional | List of fields to exclude from the report, using comma-separated values. Use dot notation for sub-object parameters. |
include_fields | string | Optional | A comma-separated list of fields to return. Use dot notation for sub-object parameters. |
Requirements
Output
json— Response from the API endpoint 'getReportingFacebookAdsId'.MailchimpMarketingApi.GetFacebookAdsList
Retrieve a list of Facebook ads from Mailchimp. Use this tool to obtain a list of Facebook ads managed within Mailchimp. Ideal for getting an overview of current ad campaigns.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
exclude_fields | string | Optional | A comma-separated list of fields to exclude. Utilize dot notation for sub-object fields. |
fields_to_return | string | Optional | A comma-separated list of specific fields to return in the response. Use dot notation for sub-object parameters. |
pagination_offset | string | Optional | The number of records to skip for pagination, with a default of 0. |
records_count | string | Optional | Specify the number of Facebook ad records to return. Default is 10, maximum is 1000. |
sort_by_field | string | Optional | Specify the field by which to sort the Facebook ads. |
sort_direction | string | Optional | Specifies the sorting order: 'asc' for ascending or 'desc' for descending. |
Requirements
Output
json— Response from the API endpoint 'getAllFacebookAds'.MailchimpMarketingApi.GetFacebookAdsProductActivity
Retrieve product activity breakdown for a Facebook ads outreach. This tool provides a breakdown of ecommerce product activity for a specific Facebook ads outreach campaign. It should be called when detailed analytics of product performance related to a Facebook ad outreach is needed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
outreach_id | string | Required | The unique identifier for the Facebook ads outreach campaign to retrieve the product activity breakdown. |
exclude_fields | string | Optional | Comma-separated list of fields to exclude using dot notation for sub-objects. |
fields_to_return | string | Optional | A comma-separated list of fields to include in the response, using dot notation for sub-objects. |
number_of_records_to_return | string | Optional | The number of records to return. Default is 10. Maximum is 1000. |
pagination_offset | string | Optional | Number of records to skip for pagination. Default is 0. |
sort_by_field | string | Optional | Specify the field to sort the returned records by, using the field name. |
Requirements
Output
json— Response from the API endpoint 'getReportingFacebookAdsIdEcommerceProductActivity'.MailchimpMarketingApi.GetFacebookAdsReports
Get reports of Facebook ads for marketing analysis. Use this tool to retrieve detailed reports of Facebook ads data, which can be essential for analyzing marketing campaigns and performance metrics.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
exclude_fields | string | Optional | A comma-separated list of fields to exclude in the report. Use dot notation for sub-objects if needed. |
include_fields | string | Optional | Comma-separated list of fields to return. Use dot notation for sub-object parameters. |
pagination_offset | string | Optional | The number of records to skip for pagination. Default is 0. |
record_count | string | Optional | Specify the number of Facebook ads records to return. Default is 10, maximum is 1000. |
sort_order_direction | string | Optional | Specifies the order direction for sorting results. Use 'asc' for ascending and 'desc' for descending. |
sorting_field_for_results | string | Optional | Specifies the field by which to sort the Facebook ads report results. |
Requirements
Output
json— Response from the API endpoint 'getReportingFacebookAds'.MailchimpMarketingApi.GetFileManagerFileInfo
Retrieve information about a specific file from Mailchimp's File Manager. Use this tool to get detailed information about a specific file stored in Mailchimp's File Manager using the file ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
file_manager_file_id | string | Required | The unique ID for the File Manager file to retrieve its information. |
exclude_fields_list | string | Optional | Comma-separated list of fields to exclude, using dot notation for sub-objects. |
return_fields | string | Optional | A comma-separated list of fields to return. Use dot notation to specify sub-objects. |
Requirements
Output
json— Response from the API endpoint 'getFileManagerFilesId'.MailchimpMarketingApi.GetFileManagerFiles
Retrieve images and files from the Mailchimp File Manager. Use this tool to get a list of all images and files stored in the File Manager of the Mailchimp account. It provides access to media assets used in marketing campaigns.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
created_after_date | string | Optional | Files created after this date will be included in the response. Use ISO 8601 format: 2015-10-21T15:41:36+00:00. |
exclude_fields_list | string | Optional | Comma-separated fields to omit from the response. Use dot notation for sub-objects. |
fields_to_return | string | Optional | A comma-separated list of fields to return. Use dot notation for sub-object parameters. |
file_created_by_user | string | Optional | The Mailchimp account user who created the File Manager file. |
file_sort_field | string | Optional | Specify the field to sort the files by, such as 'name', 'date', etc. |
file_type | string | Optional | The file type to filter File Manager files. Expected as a string value. |
number_of_records_to_return | string | Optional | Specifies the number of records to return. Default is 10; maximum is 1000. |
pagination_offset | string | Optional | The number of records to skip for pagination. Default is 0. |
restrict_files_before_date | string | Optional | Restrict the response to files created before the specified ISO 8601 date. |
sort_order_direction | string | Optional | Sets the order direction for sorting results. Use 'ASC' for ascending and 'DESC' for descending. |
Requirements
Output
json— Response from the API endpoint 'getFileManagerFiles'.MailchimpMarketingApi.GetFileManagerFolderInfo
Retrieve details of a specific folder from File Manager. Use this tool to get information about a particular folder in Mailchimp's File Manager. It's useful for accessing folder-specific details, such as name and metadata.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
file_manager_folder_id | string | Required | The unique identifier for the File Manager folder to retrieve. |
exclude_fields_list | string | Optional | Comma-separated fields to exclude. Use dot notation for sub-objects. |
fields_to_return | string | Optional | A comma-separated list of specific fields to return, use dot notation for sub-objects. |
Requirements
Output
json— Response from the API endpoint 'getFileManagerFoldersId'.MailchimpMarketingApi.GetFolderFiles
Retrieve files and images from a specific folder. Use this tool to get a list of available images and files stored in a specified folder within Mailchimp's file manager. Ideal for accessing and managing digital assets.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
file_manager_folder_id | string | Required | The unique identifier for the specific File Manager folder to retrieve files from. |
exclude_fields | string | Optional | Comma-separated list of fields to exclude. Use dot notation for sub-object parameters. |
fields_to_return | string | Optional | A comma-separated list of fields to return. Use dot notation for sub-object fields. |
file_creator_user | string | Optional | Mailchimp account user who created the File Manager file. Filter results by this user's contributions. |
file_type | string | Optional | Specifies the file type to filter files in the folder. Use to retrieve specific types like 'image', 'document', etc. |
filter_files_created_after | string | Optional | Restrict the response to files created after the specified date in ISO 8601 format (e.g., 2015-10-21T15:41:36+00:00). |
number_of_records | string | Optional | Specifies the number of files to retrieve, with a default of 10 and a maximum of 1000. |
pagination_offset | string | Optional | The number of records to skip for pagination. Default is 0. Use this to access pages beyond the first one. |
restrict_files_before_date | string | Optional | Restrict response to files created before this date using ISO 8601 format (e.g., 2015-10-21T15:41:36+00:00). |
sort_by_field | string | Optional | Specify the field to sort the files by, such as name or size. |
sort_order_direction | string | Optional | Specify the order direction for sorting results. Typically 'asc' for ascending or 'desc' for descending order. |
Requirements
Output
json— Response from the API endpoint 'getFileManagerFoldersFiles'.MailchimpMarketingApi.GetInterestCategoryInfo
Fetch specific interest category details from a Mailchimp list. Use this tool to get detailed information about a specific interest category within a Mailchimp list. This is useful for understanding subscriber interests and organizing lists more effectively.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
interest_category_unique_id | string | Required | The unique ID for the interest category you want to retrieve information about. |
list_unique_id | string | Required | The unique ID for the Mailchimp list you want to retrieve interest category details from. |
fields_to_exclude | string | Optional | Comma-separated list of fields to exclude, using dot notation for sub-objects. |
fields_to_return | string | Optional | Comma-separated list of fields to include in the response, using dot notation for sub-objects. |
Requirements
Output
json— Response from the API endpoint 'getListsIdInterestCategoriesId'.MailchimpMarketingApi.GetInterestCategoryInterests
Retrieve interests for a specific category in Mailchimp. Use this tool to get a list of interests within a specific category of a Mailchimp list. It helps in understanding what options are available under a given interest category for targeted marketing strategies.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
interest_category_unique_id | string | Required | The unique identifier for a specific interest category in a Mailchimp list. |
list_unique_id | string | Required | The unique ID for the Mailchimp list. |
excluded_fields | string | Optional | Comma-separated list of fields to exclude, using dot notation for sub-objects. |
fields_to_return | string | Optional | Comma-separated list of fields to return, using dot notation as needed. |
number_of_records_to_return | string | Optional | Specify the number of records to return, between 10 and 1000. Default is 10. |
pagination_skip_count | string | Optional | The number of records to skip for pagination. Default is 0. |
Requirements
Output
json— Response from the API endpoint 'getListsIdInterestCategoriesIdInterests'.MailchimpMarketingApi.GetInterestGroupNames
Retrieve interest group names for a specific category. Use this tool to fetch interests or 'group names' associated with a specific category in a Mailchimp list. It is useful for managing or displaying group names to users.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
interest_category_id | string | Required | The unique identifier for the interest category in a Mailchimp list. |
list_unique_id | string | Required | The unique identifier for the Mailchimp list to retrieve interest group names from. |
specific_interest_group_name | string | Required | The specific interest or group name to retrieve in the category. |
exclude_fields | string | Optional | Comma-separated list of fields to exclude, using dot notation for sub-objects. |
include_fields | string | Optional | A comma-separated list of fields to return, using dot notation for sub-objects. |
Requirements
Output
json— Response from the API endpoint 'getListsIdInterestCategoriesIdInterestsId'.MailchimpMarketingApi.GetLandingPageHtml
Retrieve the HTML content of a Mailchimp landing page.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
landing_page_id | string | Required | The unique identifier for the Mailchimp landing page to retrieve. |
exclude_fields_list | string | Optional | A comma-separated list of fields to exclude from the response using dot notation for sub-objects. |
fields_to_return | string | Optional | A comma-separated list of fields to return, using dot notation for nested objects. |
Requirements
Output
json— Response from the API endpoint 'getLandingPageIdContent'.MailchimpMarketingApi.GetLandingPageInfo
Retrieve information about a specific landing page by ID. This tool is used to fetch detailed information about a landing page using its ID. It should be called when you need to access the specifics of a given landing page.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
landing_page_id | string | Required | The unique identifier for the landing page to retrieve information about. |
exclude_fields_list | string | Optional | A comma-separated list of fields to exclude. Use dot notation for sub-object parameters. |
fields_to_return | string | Optional | A comma-separated list of fields to return. Use dot notation for sub-object parameters. |
Requirements
Output
json— Response from the API endpoint 'getLandingPageId'.MailchimpMarketingApi.GetLandingPageReport
Retrieve the report for a specific landing page. Use this tool to get detailed reports on specific landing pages via their ID. Useful for analyzing landing page performance and metrics.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
landing_page_outreach_id | string | Required | The outreach ID for the landing page you want to retrieve the report for. |
exclude_report_fields | string | Optional | A comma-separated list of fields to exclude from the landing page report. Use dot notation for sub-objects. |
fields_to_return | string | Optional | A comma-separated list of fields to return, using dot notation for sub-objects. |
Requirements
Output
json— Response from the API endpoint 'getReportingLandingPagesId'.MailchimpMarketingApi.GetLandingPageReports
Retrieve reports of landing pages from Mailchimp. Use this tool to get detailed analytics and reports on landing pages set up in Mailchimp. Ideal for understanding performance metrics and engagement data.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
fields_to_exclude | string | Optional | A comma-separated list of fields to exclude from the report. Use dot notation for sub-objects. |
include_fields | string | Optional | A comma-separated list of fields to include in the response, using dot notation for sub-objects. |
number_of_records_to_return | string | Optional | Specify the number of records to return, from 1 to 1000. Defaults to 10 if not provided. |
records_to_skip | string | Optional | The number of records to skip for pagination. Default is 0. |
Requirements
Output
json— Response from the API endpoint 'getReportingLandingPages'.MailchimpMarketingApi.GetListGrowthSummary
Get a list's growth activity summary for a specific month and year. Use this tool to obtain a summary of the growth activity for a specific list in a given month and year on Mailchimp.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
list_unique_id | string | Required | The unique ID for the specific list in Mailchimp. |
specific_month_of_growth_history | string | Required | Specify the month and year (in 'YYYY-MM' format) for retrieving the list's growth history. |
exclude_fields_list | string | Optional | Comma-separated list of fields to exclude. Use dot notation for sub-objects. |
fields_to_return | string | Optional | Comma-separated list of fields to return, using dot notation for sub-objects. |
Requirements
Output
json— Response from the API endpoint 'getListsIdGrowthHistoryId'.MailchimpMarketingApi.GetListInterestCategories
Retrieve interest categories for a specific mailing list. Use this tool to obtain detailed information about the interest categories associated with a specific mailing list in Mailchimp Marketing.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
list_id | string | Required | The unique identifier for the mailing list you want to retrieve interest categories for. |
exclude_fields_list | string | Optional | Comma-separated list of fields to exclude using dot notation for sub-objects. Helps reduce the size of the response by omitting unnecessary data. |
include_fields | string | Optional | A comma-separated list of fields to return. Use dot notation for sub-objects. |
interest_group_type | string | Optional | Specify the type of interest group to restrict results. Example: 'checkboxes', 'radio_buttons'. |
pagination_offset | string | Optional | The number of records to skip for pagination. Default is 0. Use to manage pagination flow. |
record_count | string | Optional | The number of records to return. Specify a value from 10 to 1000. Defaults to 10 if not provided. |
Requirements
Output
json— Response from the API endpoint 'getListsIdInterestCategories'.MailchimpMarketingApi.GetListMemberInfo
Retrieve details about a specific list member in Mailchimp. Get information about a specific list member, including their subscription status and other details. Useful for tracking and managing member information in Mailchimp mailing lists.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
list_id | string | Required | The unique ID for the Mailchimp list to retrieve the member from. |
member_identifier | string | Required | The MD5 hash of the lowercase list member's email, or the email address/contact_id itself. |
fields_to_exclude | string | Optional | A comma-separated list of fields to exclude from the response. Use dot notation for sub-objects. |
fields_to_return | string | Optional | Comma-separated list of fields to return. Use dot notation for sub-object parameters. |
Requirements
Output
json— Response from the API endpoint 'getListsIdMembersId'.MailchimpMarketingApi.GetListMemberNote
Retrieve a specific note for a list member. Use this tool to obtain details of a particular note associated with a member of a specific list. It's helpful for accessing specific interactions or annotations recorded for a list member.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
list_unique_id | string | Required | The unique identifier for the mailing list to retrieve a member's note from. |
member_identifier | string | Required | The MD5 hash of the lowercase email, the email address itself, or contact ID for a list member. |
note_id | string | Required | The unique identifier for the note associated with a list member. |
exclude_fields | string | Optional | A comma-separated list of fields to exclude using dot notation for sub-objects. |
fields_to_return | string | Optional | A comma-separated list of fields to return, using dot notation for sub-objects. |
Requirements
Output
json— Response from the API endpoint 'getListsIdMembersIdNotesId'.MailchimpMarketingApi.GetListSegmentsInfo
Retrieve details of all segments for a specific list. Use this tool to get information about all available segments for a specific list in Mailchimp. It helps in understanding the segmentation structure of a mailing list.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
list_identifier | string | Required | The unique identifier for the mailing list whose segments are to be retrieved. |
created_after_datetime | string | Optional | Restrict results to segments created after the specified time using ISO 8601 format (e.g., 2015-10-21T15:41:36+00:00). |
exclude_fields | string | Optional | Comma-separated list of fields to exclude from the response. Use dot notation for sub-objects. |
fields_to_return | string | Optional | A comma-separated list of fields to return, using dot notation for sub-objects. |
include_cleaned_members | string | Optional | Set to 'true' to include cleaned (bounced) members in the response. Use this to see members who have been removed due to email issues. |
include_transactional_members | string | Optional | Specify whether to include transactional members in the response. Use 'true' or 'false'. |
include_unsubscribed_members | string | Optional | Set to 'true' to include unsubscribed members in the response. |
pagination_offset | string | Optional | The number of records to skip for pagination. Default is 0. |
records_count | string | Optional | The number of records to return. Default: 10. Max: 1000. |
restrict_since_updated_time | string | Optional | Restrict results to segments updated after this time using ISO 8601 format (e.g., 2015-10-21T15:41:36+00:00). |
restrict_to_segments_created_before | string | Optional | Restrict results to segments created before the specified time. Use ISO 8601 format: 2015-10-21T15:41:36+00:00. |
restrict_to_segments_updated_before | string | Optional | Restrict results to segments updated before the specified time using ISO 8601 format (e.g., 2015-10-21T15:41:36+00:00). |
segment_type | string | Optional | Specify the type of segment to filter results. Use known segment types as strings. |
Requirements
Output
json— Response from the API endpoint 'previewASegment'.MailchimpMarketingApi.GetListSignupForms
Retrieve signup forms for a Mailchimp list. Use this tool to fetch all signup forms associated with a specific Mailchimp list using the list ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
list_unique_id | string | Required | The unique ID of the Mailchimp list for retrieving signup forms. |
Requirements
Output
json— Response from the API endpoint 'getListsIdSignupForms'.MailchimpMarketingApi.GetListSubscriberLocations
Retrieve subscriber location data by list. Call this tool to get the countries associated with the subscribers of a specific list in Mailchimp, based on geocoded IP addresses.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
list_unique_id | string | Required | The unique ID for the subscriber list in Mailchimp. |
exclude_fields | string | Optional | Comma-separated list of fields to exclude using dot notation for sub-objects. |
include_fields | string | Optional | A comma-separated list of fields to include in the response. Use dot notation for sub-object parameters. |
Requirements
Output
json— Response from the API endpoint 'getListsIdLocations'.MailchimpMarketingApi.GetListSurveysInfo
Retrieve information about surveys for a specific list. Call this tool to get information about all available surveys associated with a specific list in Mailchimp. Useful for managing and analyzing survey data linked to email lists.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
list_unique_id | string | Required | The unique identifier for the list to retrieve survey information. This ID is essential for specifying which list's surveys to access. |
Requirements
Output
json— Response from the API endpoint 'getListsIdSurveys'.MailchimpMarketingApi.GetListWebhooksInfo
Get information about all webhooks for a specific list. Use this tool to retrieve detailed information about all the webhooks associated with a specified mailing list. Ideal for managing or auditing webhook configurations.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
list_unique_identifier | string | Required | The unique identifier for the mailing list to retrieve webhook information. |
Requirements
Output
json— Response from the API endpoint 'getListsIdWebhooks'.MailchimpMarketingApi.GetMailchimpAccountExports
Retrieve a list of account exports in Mailchimp. Call this tool to get a list of account exports for a Mailchimp account, useful for tracking or managing account data exports.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
fields_to_exclude | string | Optional | A comma-separated list of fields to exclude. Use dot notation for sub-objects. |
fields_to_return | string | Optional | A comma-separated list of fields to return in the response. Use dot notation for nested fields. |
number_of_records | string | Optional | Specify the number of records to return. Defaults to 10, maximum is 1000. |
pagination_offset | string | Optional | Number of records to skip for pagination. Default is 0, used to manage data retrieval position. |
Requirements
Output
json— Response from the API endpoint 'getAccountExports'.MailchimpMarketingApi.GetMailchimpApiResources
Retrieve all available Mailchimp API resource links. This tool fetches links to all the resources available in the Mailchimp Marketing API, providing easy access to various API endpoints.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
exclude_fields | string | Optional | A comma-separated list of fields to exclude using dot notation for sub-objects. |
fields_to_return | string | Optional | A comma-separated list of fields to return, using dot notation for sub-object parameters. |
Requirements
Output
json— Response from the API endpoint 'getRoot'.MailchimpMarketingApi.GetMailchimpCampaignFeedback
Retrieve feedback comments for a Mailchimp campaign. Use this tool to get team feedback for a specific Mailchimp campaign by providing the campaign ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
campaign_id | string | Required | The unique identifier for the specific Mailchimp campaign from which to retrieve feedback. |
fields_to_exclude | string | Optional | Comma-separated list of fields to exclude from the feedback data, using dot notation for sub-objects. |
include_fields | string | Optional | A comma-separated list of specific fields to return, using dot notation for sub-objects. |
Requirements
Output
json— Response from the API endpoint 'getCampaignsIdFeedback'.MailchimpMarketingApi.GetMailchimpListInfo
Retrieve details of a specific list in Mailchimp. Use this tool to get detailed information about a specific list in your Mailchimp account, including members who are unconfirmed, unsubscribed, or cleaned.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mailchimp_list_id | string | Required | The unique ID for the Mailchimp list to retrieve information about. |
exclude_fields_in_mailchimp | string | Optional | A comma-separated list of fields to exclude. Use dot notation for sub-objects, e.g., 'stats.member_count'. |
fields_to_return | string | Optional | A comma-separated list of fields to return. Use dot notation for sub-object parameters. |
include_total_contacts | string | Optional | Set to true to include the approximate count of all contacts in any state (total_contacts) in the response. |
Requirements
Output
json— Response from the API endpoint 'getListsId'.MailchimpMarketingApi.GetMailchimpListMembers
Retrieve member details from a specific Mailchimp list. Use this tool to get information about members within a specified Mailchimp list. It's useful for accessing subscriber details such as email addresses and subscription status.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
list_unique_id | string | Required | The unique ID for the Mailchimp list to retrieve member information from. |
changed_after_timestamp | string | Optional | Restrict results to subscribers whose information changed after the specified timestamp in ISO 8601 format (e.g., 2015-10-21T15:41:36+00:00). |
email_type | string | Optional | Specify the type of email format. Typically 'html' or 'text'. |
fields_to_exclude | string | Optional | Comma-separated list of fields to exclude from the response, using dot notation for sub-objects. |
fields_to_return | string | Optional | A comma-separated list of fields to return. Use dot notation for sub-object parameters. |
filter_by_interest_ids | string | Optional | Comma-separated list of interest IDs to filter list members. Must be combined with interest_category_id and interest_match. |
filter_by_since_last_campaign | string | Optional | Filter subscribers by their status (subscribed/unsubscribed/pending/cleaned) since the last email campaign. Requires member status. |
filter_unsubscribed_since | string | Optional | Filter subscribers who unsubscribed since a specific date. Must use 'unsubscribed' status only. |
filter_vip_members | string | Optional | Filter to return only VIP list members. Use `true` for VIPs only, `false` for all members. |
interest_category_id | string | Optional | The unique id for the interest category used to filter Mailchimp list members. |
interest_match_filter | string | Optional | Specify how to match list members by interests. Options: 'any', 'all', or 'none'. Must accompany interest_category_id and interest_ids. |
number_of_records_to_return | string | Optional | Specify the number of records to return, between 10 and 1000, default is 10. |
opt_in_after_timestamp | string | Optional | Restrict results to subscribers who opted-in after the specified timeframe in ISO 8601 format: 2015-10-21T15:41:36+00:00. |
opt_in_before_timestamp | string | Optional | Restrict results to subscribers who opted in before the specified timeframe. Use ISO 8601 format. |
pagination_offset | string | Optional | The number of records to skip for pagination. Default is 0. |
restrict_change_before_timeframe | string | Optional | Restrict results to subscribers whose information changed before the provided timeframe in ISO 8601 format (e.g., '2015-10-21T15:41:36+00:00'). |
sort_field_for_members | string | Optional | Specifies the field by which to sort the list members. |
sort_order_direction | string | Optional | Determines the order direction for sorted results. Common values are 'asc' for ascending and 'desc' for descending. |
subscriber_status | string | Optional | The status of the subscriber (e.g., subscribed, unsubscribed, cleaned, pending). |
unique_email_identifier | string | Optional | A unique identifier for the email address across all Mailchimp lists. Use this to filter for a specific member. |
Requirements
Output
json— Response from the API endpoint 'getListsIdMembers'.MailchimpMarketingApi.GetMailchimpTemplateFolders
Retrieve all template folders from Mailchimp. Use this tool to retrieve all folders used in Mailchimp to organize templates. It is helpful for managing and categorizing your email templates.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
exclude_fields_list | string | Optional | A comma-separated list of fields to exclude. Use dot notation for sub-objects. |
include_fields | string | Optional | A comma-separated list of fields to return. Use dot notation for sub-object parameters. |
number_of_records_to_return | string | Optional | Specify the number of template folder records to return, up to a maximum of 1000. The default is 10. |
pagination_offset | string | Optional | Number of records to skip for pagination. Default is 0. |
Requirements
Output
json— Response from the API endpoint 'getTemplateFolders'.MailchimpMarketingApi.GetMailchimpTemplateInfo
Retrieves detailed information about a specific Mailchimp template. Use this tool to obtain information about a particular template in Mailchimp by providing the template ID. It is useful for retrieving template details when managing email marketing campaigns.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
template_id | string | Required | The unique identifier for the Mailchimp template to retrieve information about. |
fields_to_exclude | string | Optional | Comma-separated list of fields to exclude from the response. Use dot notation for sub-objects. |
fields_to_return | string | Optional | Specify a comma-separated list of fields to include in the response. Use dot notation for sub-object parameters. |
Requirements
Output
json— Response from the API endpoint 'getTemplatesId'.MailchimpMarketingApi.GetMemberActivity
Retrieve recent email activity for a list member. Call this tool to get the last 50 activity events for a specific member on a Mailchimp list, including actions like opens, clicks, and unsubscribes.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
list_unique_id | string | Required | The unique ID for the Mailchimp list you want to query. |
member_identifier | string | Required | MD5 hash of the lowercase email, email address, or contact ID of the list member. |
actions_to_return | string | Optional | Comma-separated list of specific member actions to retrieve, such as opens, clicks, and unsubscribes. |
exclude_fields_from_activity | string | Optional | A comma-separated list of fields to exclude from the member activity response. Use dot notation for sub-objects. |
included_fields | string | Optional | Comma-separated list of specific fields to retrieve for member activity, using dot notation for sub-objects. |
Requirements
Output
json— Response from the API endpoint 'getListsIdMembersIdActivity'.MailchimpMarketingApi.GetMemberActivityFeed
Fetch a Mailchimp list member's activity details. Use this tool to get a detailed record of a member's activities on a specific Mailchimp list, including email opens, link clicks, and unsubscribe actions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
list_unique_id | string | Required | The unique ID for the Mailchimp list. Required to retrieve the member's activity data. |
member_identifier | string | Required | The MD5 hash of the lowercase version of the list member's email address, or the email address itself, or contact_id. |
activity_type_filters | string | Optional | Comma-separated list of activity types to filter by, such as 'open', 'bounce', or 'click'. |
exclude_fields_from_response | string | Optional | Comma-separated list of fields to exclude from the response, use dot notation for sub-objects. |
fields_to_return | string | Optional | A comma-separated list of fields to include in the response. Use dot notation for sub-objects. |
number_of_records_to_return | string | Optional | The number of activity records to return. Default is 10, max is 1000. |
pagination_offset | string | Optional | The number of records to skip for pagination. Default is 0. |
Requirements
Output
json— Response from the API endpoint 'getListsIdMembersIdActivityFeed'.MailchimpMarketingApi.GetMemberGoalEvents
Retrieve the last 50 goal events for a specific list member. Use this tool to get the most recent goal achievement events for a member within a particular Mailchimp list. This can be useful for tracking user engagement and performance metrics.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
list_unique_id | string | Required | The unique identifier for the Mailchimp list. Required for fetching member goal events. |
member_identifier | string | Required | The MD5 hash of the lowercase version of the member's email, email address, or contact_id. |
exclude_fields_list | string | Optional | Comma-separated list of fields to exclude, using dot notation for sub-objects. |
include_fields | string | Optional | Comma-separated list of specific fields to return, using dot notation for sub-objects. |
Requirements
Output
json— Response from the API endpoint 'getListsIdMembersIdGoals'.MailchimpMarketingApi.GetMemberNotes
Retrieve recent notes for a Mailchimp list member. Use this tool to access the most recent notes associated with a specific member of a Mailchimp list, identified by their subscriber hash.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
list_id | string | Required | The unique ID of the Mailchimp list to retrieve notes for. |
subscriber_hash | string | Required | The MD5 hash of the lowercase version of the list member's email address. Used to identify the list member. |
exclude_fields | string | Optional | Comma-separated list of fields to exclude using dot notation for sub-objects. |
include_fields | string | Optional | A comma-separated list of fields to include in the response. Use dot notation for sub-object parameters. |
number_of_records_to_return | string | Optional | Specify the number of member notes to return, between 1 and 1000. Default is 10. |
order_direction | string | Optional | Specifies the order direction for sorted note results. Accepts 'asc' or 'desc'. |
pagination_offset | string | Optional | The number of records to skip for pagination. Default is 0. |
sort_notes_by_field | string | Optional | Specify the field to sort the notes by, e.g., 'created_at' or 'updated_at'. |
Requirements
Output
json— Response from the API endpoint 'getListsIdMembersIdNotes'.MailchimpMarketingApi.GetMergeFieldInfo
Retrieve information about a specific merge field. Use this tool to obtain detailed information about a specific merge field in a Mailchimp list. It's useful for accessing customized data fields associated with members of email lists.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
list_id | string | Required | The unique ID of the Mailchimp list to get merge field information from. |
merge_field_id | string | Required | The unique identifier for the merge field in the list. |
exclude_merge_fields | string | Optional | Comma-separated list of fields to exclude using dot notation for sub-object parameters. |
fields_to_return | string | Optional | Specify the fields to return, using comma-separated dot notation for nested fields. |
Requirements
Output
json— Response from the API endpoint 'getListsIdMergeFieldsId'.MailchimpMarketingApi.GetMonthlyListGrowthSummary
Retrieve monthly summary of a list's growth activity. Use this tool to get a detailed month-by-month summary of the growth activity for a specific list in Mailchimp. It provides insights into subscriber count changes over time.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
list_unique_id | string | Required | The unique identifier for the specific list in Mailchimp. Required for retrieving growth activity. |
exclude_fields_to_return | string | Optional | A comma-separated list of fields to exclude from the response, using dot notation for sub-objects. |
pagination_offset | string | Optional | Number of records to skip for pagination. Default is 0. |
records_to_return | string | Optional | Specify the number of records to return, with a default of 10 and a maximum of 1000. |
return_fields | string | Optional | A comma-separated list of specific fields to return. Use dot notation for sub-object parameters. |
sort_order_direction | string | Optional | Determines the sorting order for the results, either ascending or descending. |
sort_results_by_field | string | Optional | Specify the field by which results should be sorted. Use dot notation for sub-object fields. |
Requirements
Output
json— Response from the API endpoint 'getListsIdGrowthHistory'.MailchimpMarketingApi.GetOrderLineItems
Retrieve information about order line items. Use this tool to get detailed information about line items in a specific order from an e-commerce store linked to Mailchimp.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
order_id | string | Required | The unique identifier for the order within the store. Required to specify which order's line items to retrieve. |
store_id | string | Required | The unique identifier for the store. Used to specify which store's order line items to retrieve. |
exclude_fields | string | Optional | Comma-separated list of fields to exclude, using dot notation for sub-objects. |
fields_to_return | string | Optional | A comma-separated list of fields to return, using dot notation for sub-objects. |
number_of_records_to_return | string | Optional | Specify the number of line item records to return, between 1 and 1000. Default is 10. |
pagination_offset | string | Optional | Number of records to skip for pagination, default is 0. |
Requirements
Output
json— Response from the API endpoint 'getEcommerceStoresIdOrdersIdLines'.MailchimpMarketingApi.GetProductImageInfo
Retrieve details of a specific product image in an eCommerce store. Use this tool to get information about a specific image associated with a product in an eCommerce store. Ideal for obtaining image metadata or details for display or analysis purposes.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
product_identifier | string | Required | The unique identifier for the product in the store. |
product_image_id | string | Required | The unique identifier for the product image to retrieve details about. |
store_identifier | string | Required | The unique identifier of the store. Used to specify the store whose product image information is to be retrieved. |
exclude_fields_list | string | Optional | A comma-separated list of fields to exclude, using dot notation for sub-object parameters. |
fields_to_return | string | Optional | A comma-separated list of fields to return. Use dot notation for sub-object fields. |
Requirements
Output
json— Response from the API endpoint 'getEcommerceStoresIdProductsIdImagesId'.MailchimpMarketingApi.GetProductImages
Retrieve information about a product's images. Call this tool to obtain details about images associated with a specific product in an e-commerce store.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
product_identifier | string | Required | The unique identifier for a product in a specific store. Required to retrieve product image details. |
store_id | string | Required | The unique identifier for the e-commerce store. |
exclude_fields | string | Optional | A comma-separated list of fields to exclude from the response using dot notation for sub-objects. |
fields_to_return | string | Optional | A comma-separated list of fields to return. Use dot notation for sub-objects. |
number_of_records_to_return | string | Optional | Specify the number of product image records to return, ranging from 1 to 1000. Defaults to 10 if not provided. |
pagination_offset | string | Optional | The number of records to skip for pagination. Default is 0. |
Requirements
Output
json— Response from the API endpoint 'getEcommerceStoresIdProductsIdImages'.MailchimpMarketingApi.GetProductInfo
Get information about a specific product from an ecommerce store. Use this tool to retrieve detailed information on a specific product from a specified ecommerce store, identified by store and product IDs.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
product_id | string | Required | The unique identifier for the product within a store. This ID is required to fetch specific product details. |
store_identifier | string | Required | The unique identifier for the store from which to retrieve the product information. |
fields_to_exclude | string | Optional | Comma-separated fields to exclude in the response, using dot notation for sub-objects. |
fields_to_return | string | Optional | A comma-separated list of fields to return, using dot notation for sub-objects. |
Requirements
Output
json— Response from the API endpoint 'getEcommerceStoresIdProductsId'.MailchimpMarketingApi.GetProductVariantInfo
Retrieve information on a specific product variant. Call this tool to get detailed information about a specific product variant in an e-commerce store. Useful for fetching variant details such as size, color, price, or stock status from a specified store's product.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
product_id | string | Required | The ID of the product in the specified store. Required to retrieve variant details. |
product_variant_id | string | Required | The unique identifier for the product variant in the store. |
store_id | string | Required | The unique identifier for the store to query the product variant details. |
exclude_fields | string | Optional | Comma-separated list of fields to exclude in the response. Use dot notation for sub-object parameters. |
fields_to_return | string | Optional | A comma-separated list of product variant fields to return, using dot notation for sub-objects. |
Requirements
Output
json— Response from the API endpoint 'getEcommerceStoresIdProductsIdVariantsId'.MailchimpMarketingApi.GetProductVariantsInfo
Retrieve information on product variants from a store. Use this tool to obtain detailed information about the variants of a specific product in an e-commerce store. Ideal for cases where users need to know different versions or options available for a product.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
product_identifier | string | Required | The unique identifier for the product within the store. |
store_id | string | Required | The unique identifier for the store. Required to fetch product variant data. |
exclude_fields_list | string | Optional | Specify fields to exclude using a comma-separated list. Use dot notation for sub-objects. |
fields_to_return | string | Optional | Comma-separated list of fields to return, using dot notation for sub-objects. |
number_of_records_to_return | string | Optional | Specify the number of product variant records to return, default is 10, max is 1000. |
pagination_offset | string | Optional | Number of records to skip for pagination. Default is 0. |
Requirements
Output
json— Response from the API endpoint 'getEcommerceStoresIdProductsIdVariants'.MailchimpMarketingApi.GetPromoCodeInfo
Retrieve details of a specific promo code. Use this tool to get detailed information about a specific promo code associated with a particular store in the Mailchimp Marketing service.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
promo_code_id | string | Required | The unique identifier for the promo code associated with a store. |
promo_rule_id | string | Required | The unique identifier for the promo rule of a store. This is required to fetch specific promo code information. |
store_id | string | Required | The unique identifier for the store. Required to specify which store's promo code information to retrieve. |
exclude_fields | string | Optional | Comma-separated list of fields to exclude using dot notation for sub-objects. |
fields_to_return | string | Optional | A comma-separated list of fields to return, using dot notation for sub-objects. |
Requirements
Output
json— Response from the API endpoint 'getEcommerceStoresIdPromocodesId'.MailchimpMarketingApi.GetPromoRuleInfo
Retrieve information about a specific promo rule in an ecommerce store.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
promo_rule_id | string | Required | The unique identifier for the promo rule in the store. Required to fetch specific rule details. |
store_id | string | Required | The unique identifier for the ecommerce store. Required to fetch promo rule details. |
exclude_fields | string | Optional | A comma-separated list of fields to exclude from the promo rule data. Use dot notation to reference sub-objects. |
include_fields | string | Optional | A comma-separated list of specific fields to return using dot notation for sub-objects. |
Requirements
Output
json— Response from the API endpoint 'getEcommerceStoresIdPromorulesId'.MailchimpMarketingApi.GetRemovedAutomationSubscribers
Get details on subscribers removed from automation workflows. Use this tool to obtain information about subscribers who have been removed from a specific classic automation workflow in Mailchimp.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
automation_workflow_id | string | Required | The unique ID for identifying the specific automation workflow in Mailchimp. |
Requirements
Output
json— Response from the API endpoint 'getAutomationsIdRemovedSubscribers'.MailchimpMarketingApi.GetRemovedSubscriberInfo
Retrieve details about a removed subscriber from automation. Use this tool to get specific information about a subscriber who was removed from a classic Mailchimp automation workflow by providing the workflow ID and subscriber hash.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
automation_workflow_id | string | Required | The unique ID for the Mailchimp automation workflow. It is required to identify from which workflow the subscriber was removed. |
subscriber_hash | string | Required | MD5 hash of the lowercase version of the subscriber's email address to identify the removed member. |
Requirements
Output
json— Response from the API endpoint 'getAutomationsIdRemovedSubscribersId'.MailchimpMarketingApi.GetSegmentInfo
Retrieve information about a specific Mailchimp segment. Use this tool to get detailed information about a specific segment in a Mailchimp list by providing the list and segment IDs.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
list_unique_id | string | Required | The unique ID for the Mailchimp list to fetch segment information from. |
segment_id | string | Required | Provide the unique ID for the segment you want information on. |
exclude_fields_list | string | Optional | Comma-separated list of fields to exclude, using dot notation for sub-objects. |
fields_to_return | string | Optional | Comma-separated list of fields to return, using dot notation for sub-objects. |
include_cleaned_members | string | Optional | Set to 'true' to include cleaned members in the response. Cleaned members are those deleted due to bounce or other delivery issues. |
include_transactional_members | string | Optional | Set to 'true' to include transactional members in the response. |
include_unsubscribed_members | string | Optional | Set to 'true' to include unsubscribed members in the response. |
Requirements
Output
json— Response from the API endpoint 'getListsIdSegmentsId'.MailchimpMarketingApi.GetSegmentMembersInfo
Get information about members in a saved segment. Use this tool to retrieve information about members within a specified segment. It is useful when you need details on who is part of a particular saved segment in a mailing list.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
list_identifier | string | Required | The unique ID representing the mailing list from which the segment members will be retrieved. This ID is required to specify the context of the segment. |
segment_unique_id | string | Required | The unique ID for the segment to retrieve members from. |
fields_to_exclude | string | Optional | Comma-separated list of fields to exclude using dot notation for sub-objects. |
include_cleaned_members | string | Optional | Specify 'true' to include cleaned (invalid or bounced) members in the response. Otherwise, specify 'false'. |
include_transactional_members | string | Optional | Set to true to include transactional members in the response. |
include_unsubscribed_members | string | Optional | Specify 'true' to include unsubscribed members in the response, 'false' to exclude them. |
included_fields | string | Optional | Comma-separated list of specific fields to return. Use dot notation for sub-object parameters. |
pagination_offset | string | Optional | The number of records to skip for pagination purposes. Default is 0. |
records_to_return | string | Optional | The number of records to return. Default is 10; maximum is 1000. |
Requirements
Output
json— Response from the API endpoint 'getListsIdSegmentsIdMembers'.MailchimpMarketingApi.GetSpecificOrderInfo
Retrieve information about a specific order in a store. Use this tool to obtain details about a specific order from an e-commerce store. It should be called when needing to access order information using the order ID and store ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
order_id | string | Required | The unique identifier for the order in a store. It is required to retrieve specific order details. |
store_identifier | string | Required | The unique identifier for the store. Required to fetch order information. |
exclude_fields_list | string | Optional | Comma-separated list of fields to exclude from the response. Use dot notation for sub-object parameters. |
include_fields | string | Optional | Comma-separated list of fields to return, using dot notation for sub-objects. |
Requirements
Output
json— Response from the API endpoint 'getEcommerceStoresIdOrdersId'.MailchimpMarketingApi.GetSpecificOrderLineItemInfo
Get details about a specific order line item. Use this tool to retrieve information about a specific order line item from an e-commerce store in Mailchimp. Useful for obtaining order details such as product name, quantity, price, etc., for a particular order line.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
order_id | string | Required | The unique identifier for the order within a store. Required to fetch details of the specific order line item. |
order_line_item_id | string | Required | The unique identifier for the line item in the order. |
store_identifier | string | Required | The unique identifier for the store. This is required to specify which store's data to retrieve. |
exclude_fields | string | Optional | A comma-separated list of specific fields to exclude from the response. Use dot notation for sub-object fields. |
return_fields | string | Optional | Comma-separated list of fields to return. Use dot notation for sub-objects. |
Requirements
Output
json— Response from the API endpoint 'getEcommerceStoresIdOrdersIdLinesId'.MailchimpMarketingApi.GetStoreCartsInfo
Retrieve information about a store's ecommerce carts. Use this tool to get detailed information about carts within a specific store in the ecommerce system. Ideal for understanding cart statuses, contents, and customer interactions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
store_identifier | string | Required | The unique identifier for the store to retrieve cart information. |
exclude_fields | string | Optional | Comma-separated list of fields to exclude from the response. Use dot notation for sub-objects. |
fields_to_return | string | Optional | A comma-separated list of fields to include in the response, using dot notation for nested objects. |
number_of_records_to_return | string | Optional | Specify the number of records to return, up to a maximum of 1000. Default is 10. |
pagination_offset | string | Optional | The number of records to skip for pagination. Default is 0. |
Requirements
Output
json— Response from the API endpoint 'getEcommerceStoresIdCarts'.MailchimpMarketingApi.GetStoreCustomersInfo
Retrieve information about a store's customers. Use this tool to get detailed information about the customers of a specific e-commerce store. Ideal for accessing customer data to analyze or manage store interactions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
store_identifier | string | Required | The unique identifier for the e-commerce store to retrieve customer information. |
fields_to_exclude | string | Optional | Comma-separated fields to exclude in the response, using dot notation for sub-objects. |
fields_to_return | string | Optional | A comma-separated list of fields to return, using dot notation for sub-objects. |
filter_by_email_address | string | Optional | Restrict the response to customers matching the specified email address. |
number_of_records_to_return | string | Optional | The number of customer records to return. Default is 10, maximum is 1000. |
pagination_offset | string | Optional | Number of records to skip for pagination. Default is 0. |
Requirements
Output
json— Response from the API endpoint 'getEcommerceStoresIdCustomers'.MailchimpMarketingApi.GetStoreOrdersInfo
Retrieve information about a store's orders via Mailchimp. Use this tool to get detailed information about the orders of a specified store from Mailchimp's ecommerce platform.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
store_identifier | string | Required | The unique identifier for the store whose orders information is to be retrieved. |
exclude_order_fields | string | Optional | Comma-separated list of order fields to exclude, using dot notation for sub-objects. |
fields_to_return | string | Optional | A comma-separated list of fields to return. Use dot notation for sub-objects. |
filter_by_customer_id | string | Optional | Restrict results to orders made by a specific customer using their unique customer ID. |
number_of_records_to_return | string | Optional | Specify the number of records to return, between 1 and 1000, with a default of 10. |
pagination_offset | string | Optional | Number of records to skip for pagination. Default is 0. |
restrict_to_campaign_id | string | Optional | Restrict results to orders with the specified `campaign_id`. |
restrict_to_outreach_orders | string | Optional | Indicate whether to restrict results to orders with an outreach attached, such as an email campaign or Facebook ad. Accepts 'true' or 'false'. |
specific_outreach_id | string | Optional | Restrict results to orders with a specific outreach ID. |
Requirements
Output
json— Response from the API endpoint 'getEcommerceStoresIdOrders'.MailchimpMarketingApi.GetStoreProductsInfo
Get information about a store's products from Mailchimp. This tool retrieves detailed information about products in a specified ecommerce store using Mailchimp's marketing API. It should be called when information about a store's inventory is needed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
store_identifier | string | Required | The unique identifier for the store whose product information is being retrieved. |
exclude_fields_list | string | Optional | Comma-separated list of fields to exclude from the response. Use dot notation for sub-object parameters. |
number_of_records_to_return | string | Optional | Specify the number of product records to return, from 1 to 1000. The default value is 10. |
pagination_offset | string | Optional | The number of records to skip for pagination. Default is 0. |
return_fields_list | string | Optional | A comma-separated list of specific fields to return. Use dot notation for sub-objects. |
Requirements
Output
json— Response from the API endpoint 'getEcommerceStoresIdProducts'.MailchimpMarketingApi.GetStorePromoCodes
Retrieve information about promo codes for a specific store. Use this tool to get detailed information about promo codes for a given store, which can help in managing promotions and discounts.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
promo_rule_id | string | Required | The unique identifier for the promotion rule of a store to fetch promo codes. |
store_identifier | string | Required | The unique identifier for the store to get promo codes from. Required to specify which store's promo codes to retrieve. |
exclude_fields_list | string | Optional | Specify a comma-separated list of fields to exclude from the returned data. Use dot notation for sub-objects. |
fields_to_return | string | Optional | Comma-separated list of specific fields to include in the response, using dot notation for sub-objects. |
number_of_records_to_return | string | Optional | The number of promo code records to return. Default is 10, with a maximum of 1000. |
pagination_offset | string | Optional | The number of records to skip for pagination purposes. Default is 0. |
Requirements
Output
json— Response from the API endpoint 'getEcommerceStoresIdPromocodes'.MailchimpMarketingApi.GetStorePromoRules
Retrieve promo rules for a specified store. Use this tool to get detailed information about the promotional rules set up for a specific e-commerce store using its ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
store_identifier | string | Required | The unique identifier for the store to retrieve promo rules from. |
exclude_fields_list | string | Optional | Comma-separated list of fields to exclude from the response. Use dot notation for sub-objects. |
fields_to_return | string | Optional | A comma-separated list of fields to return, using dot notation for sub-objects. |
pagination_offset | string | Optional | The number of records to skip for pagination, with a default value of 0. |
records_to_return | string | Optional | Specify the number of promo rule records to return. Default is 10, maximum is 1000. |
Requirements
Output
json— Response from the API endpoint 'getEcommerceStoresIdPromorules'.MailchimpMarketingApi.GetSubscriberClickDetails
Retrieve details of a subscriber's link click in a campaign. This tool fetches information about a specific subscriber who clicked a link within a specific campaign in Mailchimp. It should be called when you need to analyze subscriber engagement by retrieving who clicked on which links in a campaign.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
campaign_id | string | Required | The unique identifier for the campaign to get subscriber click details. |
link_identifier | string | Required | The unique ID for the link clicked within a campaign. Use to specify which link's click details to retrieve. |
subscriber_email_hash | string | Required | The MD5 hash of the lowercase version of the subscriber's email address. |
exclude_fields_list | string | Optional | Comma-separated list of fields to exclude from the result, using dot notation for sub-objects. |
fields_to_return | string | Optional | A comma-separated list of specific fields to include in the response. Use dot notation for nested objects. |
Requirements
Output
json— Response from the API endpoint 'getReportsIdClickDetailsIdMembersId'.MailchimpMarketingApi.GetSurveyDetails
Retrieve details about a specific Mailchimp survey. Use this tool to gather detailed information about a particular survey associated with a specific list in Mailchimp. It is helpful for understanding survey content, status, and related data.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
list_unique_id | string | Required | The unique identifier for the Mailchimp list associated with the survey. |
survey_id | string | Required | The unique ID of the survey to retrieve details for in Mailchimp. |
Requirements
Output
json— Response from the API endpoint 'getListsIdSurveysId'.MailchimpMarketingApi.GetSurveyQuestionAnswers
Retrieve answers for a specific survey question. Use this tool to get answers for a particular question in a given survey. Useful for analyzing survey responses to specific questions within Mailchimp.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
survey_identifier | string | Required | The unique identifier for the survey whose question answers are being retrieved. |
survey_question_id | string | Required | The unique identifier for the survey question to retrieve answers from. |
exclude_fields | string | Optional | Specify fields to exclude from the response using a comma-separated list. Use dot notation for sub-objects. |
fields_to_return | string | Optional | Comma-separated list of fields to return, using dot notation for sub-objects. |
filter_by_respondent_familiarity | string | Optional | Filter survey responses based on the familiarity level of the respondents. Accepts a string value. |
Requirements
Output
json— Response from the API endpoint 'getReportingSurveysIdQuestionsIdAnswers'.MailchimpMarketingApi.GetSurveyQuestionReport
Get report data for a specific survey question. Use this tool to retrieve detailed report information for a specific question in a survey. Useful for analyzing responses and performance of survey questions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
survey_id | string | Required | The unique identifier for the survey. Required to retrieve specific survey question reports. |
survey_question_id | string | Required | The unique ID of the survey question to get the report for. |
fields_to_exclude | string | Optional | A comma-separated list of fields to exclude from the survey question report, using dot notation for sub-objects. |
fields_to_return | string | Optional | Comma-separated list of fields to return using dot notation for sub-objects. |
Requirements
Output
json— Response from the API endpoint 'getReportingSurveysIdQuestionsId'.MailchimpMarketingApi.GetSurveyQuestionReports
Retrieve reports for survey questions by survey ID. Use this tool to obtain data regarding the responses to each question within a specific survey. Ideal for analyzing survey results and gaining insights.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
survey_identifier | string | Required | The unique identifier for the survey to retrieve question reports. |
exclude_fields_from_report | string | Optional | A comma-separated list of fields to exclude from the survey report. Use dot notation for nested fields. |
include_fields | string | Optional | Comma-separated list of fields to return for survey questions. Use dot notation for sub-object parameters. |
Requirements
Output
json— Response from the API endpoint 'getReportingSurveysIdQuestions'.MailchimpMarketingApi.GetSurveyReport
Retrieve report details for a specific survey. Call this tool to get comprehensive report details for a specified survey. Use this to analyze survey responses and results.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
survey_id | string | Required | The unique ID of the survey to retrieve the report for. |
exclude_fields_list | string | Optional | A comma-separated list of fields to exclude from the survey report. Use dot notation for sub-objects. |
fields_to_return | string | Optional | A comma-separated list of fields to include in the survey report. Use dot notation for sub-objects. |
Requirements
Output
json— Response from the API endpoint 'getReportingSurveysId'.MailchimpMarketingApi.GetSurveyReports
Retrieve detailed reports for marketing surveys. Use this tool to obtain detailed reports and insights from marketing surveys. Ideal for analyzing survey results and performance metrics.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
fields_to_exclude | string | Optional | A comma-separated list of fields to exclude from survey reports. Use dot notation for sub-object fields. |
fields_to_return | string | Optional | A comma-separated list of fields to return. Use dot notation for sub-objects. |
number_of_records | string | Optional | The number of survey report records to return. Defaults to 10. Max value is 1000. |
pagination_offset | string | Optional | Number of records to skip for pagination, default is 0. |
Requirements
Output
json— Response from the API endpoint 'getReportingSurveys'.MailchimpMarketingApi.GetSurveyResponse
Retrieve details of a specific survey response. Call this tool to get detailed information of a particular survey response using its survey and response IDs.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
survey_id | string | Required | The ID of the survey to retrieve the response from. |
survey_response_id | string | Required | The ID of the specific survey response to retrieve. |
Requirements
Output
json— Response from the API endpoint 'getReportingSurveysIdResponsesId'.MailchimpMarketingApi.GetSurveyResponses
Retrieve responses to a specific survey. Use this tool to obtain responses from a specific survey when you have the survey ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
survey_id | string | Required | The unique identifier for the survey to retrieve responses for. |
chosen_answer_id | string | Optional | The ID of the selected answer option to filter survey responses. |
exclude_survey_fields | string | Optional | A comma-separated list of fields to exclude from survey responses. Use dot notation for sub-objects. |
filter_by_respondent_familiarity | string | Optional | Filter survey responses by respondents' familiarity level. Provide a familiarity string to narrow down results. |
included_fields | string | Optional | A comma-separated list of fields to return in the response. Use dot notation for sub-objects. |
question_id | string | Optional | The ID of the question that was answered to filter responses. |
Requirements
Output
json— Response from the API endpoint 'getReportingSurveysIdResponses'.MailchimpMarketingApi.GetTemplateEditableSections
Retrieve editable sections and default content of a template. Use this tool to get the sections you can edit in a Mailchimp template, along with each section's default content. It is helpful for understanding which parts of a template can be customized.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
template_unique_id | string | Required | The unique identifier for the Mailchimp template to retrieve editable sections. |
exclude_fields_list | string | Optional | A comma-separated list of fields to exclude, using dot notation for sub-objects. |
fields_to_return | string | Optional | Comma-separated list of fields to include in the response. Use dot notation for sub-objects. |
Requirements
Output
json— Response from the API endpoint 'getTemplatesIdDefaultContent'.MailchimpMarketingApi.GetTemplateFolderInfo
Retrieve details of a specific template folder. Use this tool to get information about a particular folder used for organizing templates in Mailchimp. This is helpful when you need to know more about how your templates are categorized.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
template_folder_id | string | Required | The unique ID for the template folder to retrieve information about. |
exclude_fields_list | string | Optional | A comma-separated list of fields to exclude from the response. Use dot notation for sub-object fields. |
included_fields | string | Optional | A comma-separated list of fields to return for the folder. Use dot notation for sub-objects. |
Requirements
Output
json— Response from the API endpoint 'getTemplateFoldersId'.MailchimpMarketingApi.GetTopEmailClients
Retrieve the top email clients from a specific list. This tool retrieves a list of the top email clients based on user-agent strings for a specified list ID. It should be called when there's a need to analyze or report on the most popular email clients among subscribers of a particular list.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
list_unique_id | string | Required | The unique identifier for the email list to retrieve client data from. |
exclude_fields | string | Optional | Comma-separated list of fields to exclude from the response. Use dot notation for sub-objects. |
fields_to_return | string | Optional | A comma-separated list of fields to return. Use dot notation for sub-objects. |
Requirements
Output
json— Response from the API endpoint 'getListsIdClients'.MailchimpMarketingApi.GetUnsubscribedCampaignMembers
Get details of members unsubscribed from a specific campaign. Use this tool to retrieve detailed information about members who have unsubscribed from a specified marketing campaign.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
campaign_unique_id | string | Required | The unique identifier for the marketing campaign to retrieve unsubscribed members information. |
exclude_fields_list | string | Optional | Comma-separated list of fields to exclude using dot notation for sub-objects. |
fields_to_return | string | Optional | A comma-separated list of fields to include in the response, using dot notation for sub-objects. |
number_of_records_to_return | string | Optional | Specify the number of records to return. Default is 10 and maximum is 1000. |
pagination_offset | string | Optional | The number of records to skip for pagination, with a default value of 0. |
Requirements
Output
json— Response from the API endpoint 'getReportsIdUnsubscribed'.MailchimpMarketingApi.GetUnsubscribedMemberInfo
Retrieve info on an unsubscribed list member from a campaign. Use this tool to get information about a specific list member who has unsubscribed from a campaign in Mailchimp.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
campaign_unique_id | string | Required | The unique identifier for the Mailchimp campaign. |
subscriber_email_hash | string | Required | The MD5 hash of the lowercase version of the list member's email address for identification. |
exclude_fields_list | string | Optional | A list of fields to exclude, using dot notation for sub-objects. |
include_fields | string | Optional | Specify which fields to return, using a comma-separated list with dot notation for sub-objects. |
Requirements
Output
json— Response from the API endpoint 'getReportsIdUnsubscribedId'.MailchimpMarketingApi.GetVerifiedMailchimpDomains
Retrieve all verified sending domains for a Mailchimp account. This tool retrieves the list of all sending domains verified on a Mailchimp account. It should be called when users want to view their registered sending domains.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'getVerifiedDomains'.MailchimpMarketingApi.GetWebhookInfo
Retrieve details of a specific Mailchimp webhook. Use this tool to get detailed information about a specific webhook in your Mailchimp list by providing the list and webhook IDs.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
list_unique_id | string | Required | The unique ID for the Mailchimp list to retrieve the webhook information. |
webhook_id | string | Required | Provide the unique ID of the webhook to retrieve its information. |
Requirements
Output
json— Response from the API endpoint 'getListsIdWebhooksId'.MailchimpMarketingApi.ListFileManagerFolders
Retrieve a list of folders from the File Manager. This tool is used to obtain a list of all folders available in the File Manager, which is helpful for organizing and accessing files efficiently.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
created_after_date | string | Optional | Restrict the response to files created after the specified date in ISO 8601 format. |
created_by_user | string | Optional | The Mailchimp account user who created the File Manager file. |
exclude_fields | string | Optional | A comma-separated list of fields to exclude from the response. Use dot notation for sub-object parameters. |
fields_to_return | string | Optional | Comma-separated list of fields to include in the response, using dot notation for sub-objects. |
number_of_records_to_return | string | Optional | Specify the number of folder records to return, from 1 to 1000. Default is 10. |
pagination_offset | string | Optional | Number of records to skip for pagination. Default is 0. |
restrict_to_files_created_before | string | Optional | Restrict the response to files created before the specified date using ISO 8601 format, e.g., 2015-10-21T15:41:36+00:00. |
Requirements
Output
json— Response from the API endpoint 'getFileManagerFolders'.MailchimpMarketingApi.ManageMailchimpListMembers
Batch subscribe or unsubscribe members in a Mailchimp list. Use this tool to add or remove multiple members from a specific Mailchimp list. Ideal for managing subscriber lists efficiently. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
list_id | string | Optional | The unique ID for the specific Mailchimp list to manage. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
allow_incomplete_merge_fields | string | Optional | Allows member data without required merge fields if set to true. Defaults to false. Only used when mode is 'execute'. |
ignore_duplicate_members | string | Optional | Set to true to ignore duplicate entries in the batch request, saving the first occurrence. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'postListsId'.MailchimpMarketingApi.ModifyProductVariant
Update a product variant in an e-commerce store. Use this tool to update the details of a specific product variant in a designated e-commerce store. This is useful for changing attributes of a variant, such as pricing, stock level, or other details. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
store_identifier | string | Optional | A unique identifier for the store where the product variant will be updated. Must be a string. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
product_identifier | string | Optional | The unique identifier for a product in a store. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
product_variant_id | string | Optional | The ID for the product variant to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'patchEcommerceStoresIdProductsIdVariantsId'.MailchimpMarketingApi.PauseAutomatedEmail
Pause an automated email in a Mailchimp workflow. Use this tool to pause a specific automated email within a Mailchimp automation workflow. This can be useful when you need to temporarily stop sending an ongoing sequence.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
automation_workflow_email_id | string | Required | The unique ID for the automation workflow email to be paused. |
automation_workflow_id | string | Required | The unique ID for the Mailchimp automation workflow to pause. |
Requirements
Output
json— Response from the API endpoint 'postAutomationsIdEmailsIdActionsPause'.MailchimpMarketingApi.PauseAutomationEmails
Pause emails in a specific automation workflow. Use this tool to pause all emails in a specified classic automation workflow in Mailchimp. Ideal for temporarily halting scheduled email deliveries.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
automation_workflow_id | string | Required | The unique identifier for the specific automation workflow to be paused. |
Requirements
Output
json— Response from the API endpoint 'postAutomationsIdActionsPauseAllEmails'.MailchimpMarketingApi.PauseRssCampaign
Pause an RSS-Driven campaign. Use this tool to pause an ongoing RSS-Driven campaign in Mailchimp Marketing. It should be called when you need to temporarily stop a campaign without deleting it.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
campaign_unique_id | string | Required | The unique identifier for the RSS-Driven campaign you want to pause. It should be a string. |
Requirements
Output
json— Response from the API endpoint 'postCampaignsIdActionsPause'.MailchimpMarketingApi.PublishLandingPage
Publishes a landing page from draft or edited state. Use this tool to publish a landing page that is currently in draft, unpublished, or has been edited after a previous publication.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
landing_page_id | string | Required | The unique identifier for the landing page to publish. |
Requirements
Output
json— Response from the API endpoint 'postLandingPageIdActionsPublish'.MailchimpMarketingApi.PublishMailchimpSurvey
Publishes a Mailchimp survey from draft to published status. Use this tool to publish a Mailchimp survey that is currently in draft, unpublished, or has been edited after previous publication. The tool confirms the survey's new status upon successful publishing.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mailchimp_list_id | string | Required | The unique ID for the Mailchimp list associated with the survey. |
survey_id | string | Required | The unique identifier of the survey to be published. Required for specifying which survey to publish. |
Requirements
Output
json— Response from the API endpoint 'postListsIdSurveysIdActionsPublish'.MailchimpMarketingApi.RemoveBatchWebhook
Remove a batch webhook to stop sending webhooks to a URL. This tool deletes a batch webhook identified by its ID, ensuring that webhooks are no longer sent to the specified URL. Use this tool when you need to stop receiving batch webhooks from Mailchimp to a particular endpoint.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
batch_webhook_id | string | Required | The unique identifier for the batch webhook to remove. Use this ID to specify which webhook should be deleted, stopping any further webhook notifications to the associated URL. |
Requirements
Output
json— Response from the API endpoint 'deleteBatchWebhookId'.MailchimpMarketingApi.RemoveCampaignFeedback
Remove a specific feedback message from a campaign. Use this tool to delete a feedback message associated with a specific campaign in Mailchimp.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
campaign_unique_id | string | Required | A unique identifier for the campaign from which you want to remove feedback. |
feedback_message_id | string | Required | The unique identifier for the feedback message to be removed from the campaign. |
Requirements
Output
json— Response from the API endpoint 'deleteCampaignsIdFeedbackId'.MailchimpMarketingApi.RemoveClassicAutomationEmail
Removes a specified classic automation workflow email. Use this tool to remove a specific classic automation email from a workflow. Note that emails from certain workflow types, such as Abandoned Cart and Product Retargeting, cannot be deleted.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
automation_workflow_email_id | string | Required | The unique identifier for the specific automation workflow email to be removed. |
automation_workflow_id | string | Required | The unique identifier for the Automation workflow to target for email removal. |
Requirements
Output
json— Response from the API endpoint 'deleteAutomationsIdEmailsId'.MailchimpMarketingApi.RemoveMailchimpConnectedSite
Remove a connected site from your Mailchimp account. Use this tool to delete a connected site from your Mailchimp account, removing its integration.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
site_identifier | string | Required | The unique identifier for the connected site you wish to remove from your Mailchimp account. |
Requirements
Output
json— Response from the API endpoint 'deleteConnectedSitesId'.MailchimpMarketingApi.RemoveMemberFromMailchimpSegment
Remove a member from a Mailchimp static segment. Use this tool to delete a member from a specific static segment in Mailchimp. It should be called when you need to manage segment memberships by removing a subscriber.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
email_md5_hash | string | Required | The MD5 hash of the lowercase version of the list member's email address. |
list_unique_id | string | Required | The unique ID of the mailing list from which the member will be removed. |
segment_unique_id | string | Required | The unique identifier for the Mailchimp segment from which the member will be removed. |
Requirements
Output
json— Response from the API endpoint 'deleteListsIdSegmentsIdMembersId'.MailchimpMarketingApi.RemoveSubscriberFromWorkflow
Remove a subscriber from a Mailchimp automation workflow. This tool removes a subscriber from a specified Mailchimp classic automation workflow at any point, ensuring they cannot be re-added to the same workflow.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
automation_workflow_id | string | Required | The unique identifier for the Mailchimp automation workflow. |
subscriber_email_address | string | Required | Email address of the list member to be removed from the workflow. |
Requirements
Output
json— Response from the API endpoint 'postAutomationsIdRemovedSubscribers'.MailchimpMarketingApi.ReplicateCampaignMailchimp
Replicate a saved or sent Mailchimp campaign. This tool replicates a Mailchimp campaign that is in a saved or sent status. Use it to duplicate existing campaigns for reuse or modification.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
campaign_unique_id | string | Required | The unique identifier for the Mailchimp campaign to be replicated. |
Requirements
Output
json— Response from the API endpoint 'postCampaignsIdActionsReplicate'.MailchimpMarketingApi.ResendCampaignToSegments
Resend a campaign to specific segments. Use this tool to replicate and resend a Mailchimp campaign to segments like non-openers or new subscribers.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
campaign_unique_id | string | Required | The unique ID for identifying the campaign to replicate and resend. |
resend_shortcut_type | string | Optional | Specify the type of segment to resend the campaign to. Options: 'to_non_openers', 'to_new_subscribers', 'to_non_clickers', 'to_non_purchasers'. Default is 'to_non_openers'. |
Requirements
Output
json— Response from the API endpoint 'postCampaignsIdActionsCreateResend'.MailchimpMarketingApi.ResumeRssDrivenCampaign
Resume an RSS-Driven campaign in Mailchimp. This tool resumes an RSS-Driven campaign in Mailchimp, allowing previously paused campaigns to continue sending as planned.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
campaign_id | string | Required | The unique identifier for the RSS-driven campaign to be resumed. |
Requirements
Output
json— Response from the API endpoint 'postCampaignsIdActionsResume'.MailchimpMarketingApi.RetrieveAudienceContact
Retrieve a specific omni-channel contact in an audience.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
audience_unique_id | string | Required | The unique ID for the audience to retrieve the contact from. |
unique_contact_identifier | string | Required | A unique identifier for the contact, either a Mailchimp contact ID or a channel hash. Format: email:[md5_hash] for emails or sms:[sha256_hash] for phone numbers. |
exclude_fields_list | string | Optional | A comma-separated list of fields to exclude, using dot notation for sub-objects, when retrieving contact details. |
fields_to_return | string | Optional | A comma-separated list of fields to return, using dot notation for sub-objects. |
Requirements
Output
json— Response from the API endpoint 'getAudienceContact'.MailchimpMarketingApi.RetrieveAudienceContactList
Retrieve contacts for a specific marketing audience. Use this tool to obtain a list of omni-channel contacts associated with a particular audience in your marketing campaigns.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
audience_id | string | Required | The unique identifier for the specific audience to retrieve contacts. Ensure this ID corresponds to an existing audience. |
created_before_datetime | string | Optional | Restricts the response to contacts created at or before the specified time. Use ISO 8601 format: YYYY-MM-DDTHH:MM:SS+00:00. |
created_since | string | Optional | Restrict contacts to those created after this timestamp (exclusive). Use ISO 8601 format: YYYY-MM-DDTHH:MM:SS+00:00. |
exclude_fields_list | string | Optional | Comma-separated fields to exclude from the response, using dot notation for sub-objects. |
fields_to_return | string | Optional | A comma-separated list of fields to include in the response, using dot notation for sub-objects. |
number_of_records_to_return | string | Optional | Specifies how many records to return, from 10 to 1000. |
pagination_cursor | string | Optional | Paginate through records using a `next_cursor` from a previous request. By default, fetches the first page. |
restrict_by_update_date_before | string | Optional | Restricts the response to contacts updated at or before the specified date and time, using ISO 8601 format: YYYY-MM-DDTHH:MM:SS+00:00. |
updated_since | string | Optional | Restrict response to contacts updated after this time using ISO 8601 format (exclusive). |
Requirements
Output
json— Response from the API endpoint 'getAudienceContactList'.MailchimpMarketingApi.RetrieveCampaignSubscriberActivity
Retrieve subscriber activity for a specific campaign. Use this tool to get a list of subscriber activities for a particular email campaign in Mailchimp. It provides information on how subscribers interacted with the campaign emails.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
campaign_unique_id | string | Required | The unique identifier for a specific email campaign. |
activity_since_timestamp | string | Optional | Restrict results to email activity events occurring after this timestamp, using ISO 8601 format. |
fields_to_exclude | string | Optional | Comma-separated list of fields to exclude from the response. Use dot notation for sub-objects. |
fields_to_return | string | Optional | A comma-separated list of fields to include in the response. Use dot notation for sub-object fields. |
number_of_records_to_return | string | Optional | Specifies how many records to return. The default is 10, with a maximum of 1000. |
pagination_offset | string | Optional | The number of records to skip for pagination. Default is 0. |
Requirements
Output
json— Response from the API endpoint 'getReportsIdEmailActivity'.MailchimpMarketingApi.RetrieveCartLineItemInfo
Get information about a specific cart line item. Call this tool to obtain details about a specific item in an e-commerce cart, such as product details and quantity.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
cart_identifier | string | Required | The unique identifier for the cart. Required to retrieve specific cart line item information. |
cart_line_item_id | string | Required | The ID for the line item in a specific cart. Used to identify which item details to retrieve. |
store_identifier | string | Required | Unique identifier for the store. Use this to specify which store's cart line item you want to retrieve. |
exclude_fields | string | Optional | Comma-separated list of fields to exclude from the response. Use dot notation for sub-objects. |
fields_to_return | string | Optional | A comma-separated list of fields to return for the cart line item. Use dot notation for sub-objects. |
Requirements
Output
json— Response from the API endpoint 'getEcommerceStoresIdCartsIdLinesId'.MailchimpMarketingApi.RetrieveContactEvents
Retrieve events for a specific contact in a list. Use this tool to obtain detailed event information for a specific contact in a Mailchimp list. This is useful for tracking interactions or activities associated with a subscriber.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
contact_identifier | string | Required | The unique identifier for the list member. This can be the MD5 hash of the lowercase email address, the email address itself, or the contact ID. |
list_unique_id | string | Required | The unique identifier for the Mailchimp list from which to retrieve contact events. |
exclude_fields | string | Optional | Comma-separated fields to exclude from the response using dot notation for sub-objects. |
pagination_offset | string | Optional | The number of records to skip for pagination. Default is 0. |
records_to_return_count | string | Optional | The number of records to return. Default is 10 and maximum is 1000. |
return_field_list | string | Optional | A comma-separated list of fields to return, using dot notation for sub-objects. |
Requirements
Output
json— Response from the API endpoint 'getListsIdMembersIdEvents'.MailchimpMarketingApi.RetrieveMailchimpLists
Retrieve information about all Mailchimp lists. Call this tool to obtain details about all the lists associated with a Mailchimp account.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
created_after_date | string | Optional | Restrict results to lists created after this date in ISO 8601 format (e.g., 2015-10-21T15:41:36+00:00). |
created_before_date | string | Optional | Restrict response to lists created before the specified date in ISO 8601 format (e.g., 2015-10-21T15:41:36+00:00). |
exclude_fields_list | string | Optional | Comma-separated list of fields to exclude, using dot notation for sub-objects. |
fields_to_return | string | Optional | A comma-separated list of fields to return, using dot notation for sub-objects. |
filter_by_subscriber_email | string | Optional | Restrict results to lists that include a specific subscriber's email address. |
include_total_contacts | string | Optional | Set to true to return the total_contacts field, which includes an approximate count of all contacts in any state. |
lists_after_last_campaign_date | string | Optional | Restrict results to lists created after the last campaign send date. Use ISO 8601 format (e.g., 2015-10-21T15:41:36+00:00). |
pagination_offset | string | Optional | The number of records to skip for pagination. Default is 0. |
records_to_return | string | Optional | The number of list records to return. Accepts values between 1 and 1000, with a default of 10. |
restrict_to_ecommerce_store_lists | string | Optional | Restrict results to lists containing an active, connected, undeleted ecommerce store. Expected values are 'true' or 'false'. |
restrict_to_lists_before_last_campaign_sent | string | Optional | Restrict results to lists created before the last campaign send date (ISO 8601 format). |
sort_direction | string | Optional | Determines the order direction for the sorted results. Accepts 'asc' for ascending and 'desc' for descending. |
sort_lists_by_field | string | Optional | Field by which to sort the list results. Choose from available list fields. |
Requirements
Output
json— Response from the API endpoint 'getLists'.MailchimpMarketingApi.RetrieveMemberTags
Fetches tags for a specific mailing list member. Use this tool to retrieve all tags associated with a specific member of a mailing list identified by their subscriber hash.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
list_unique_id | string | Required | The unique identifier for the mailing list. Required to specify which list to retrieve member tags from. |
member_identifier | string | Required | The MD5 hash of the lowercase version of the email, or email address, or contact_id of the list member. |
exclude_specific_fields | string | Optional | A comma-separated list of fields to exclude using dot notation for sub-objects. |
fields_to_return | string | Optional | A comma-separated list of fields to return. Use dot notation for sub-object parameters. |
pagination_offset | string | Optional | The number of records to skip for pagination. Default is 0. |
record_count | string | Optional | Specify the number of records to return, between 1 and 1000. Default is 10. |
Requirements
Output
json— Response from the API endpoint 'getListMemberTags'.MailchimpMarketingApi.ReviewCampaignSendChecklist
Review the send checklist for a Mailchimp campaign. This tool is used to review the send checklist for a specific Mailchimp campaign. It helps to identify and resolve any potential issues before sending the campaign.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
campaign_unique_id | string | Required | The unique identifier for the campaign in Mailchimp. |
fields_to_exclude | string | Optional | Comma-separated list of fields to exclude, using dot notation for sub-objects. |
fields_to_return | string | Optional | Comma-separated list of fields to return. Use dot notation for sub-objects. |
Requirements
Output
json— Response from the API endpoint 'getCampaignsIdSendChecklist'.MailchimpMarketingApi.ScheduleCampaignDelivery
Schedule a Mailchimp campaign for delivery. Use this tool to schedule a Mailchimp campaign for delivery. Ideal for standard campaigns; for Multivariate or RSS campaigns, consider using the send action instead.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
campaign_unique_id | string | Required | The unique identifier for the Mailchimp campaign to be scheduled. |
schedule_delivery_time | string | Required | The UTC date and time to schedule the campaign for delivery in ISO 8601 format. Must be on the quarter-hour (:00, :15, :30, :45). |
batch_delivery_delay | integer | Optional | The delay in minutes between batches for campaign delivery. |
number_of_batches_for_campaign | integer | Optional | The number of batches for the campaign send. Determines how the campaign delivery is split into batches. |
use_timewarp | boolean | Optional | Set to true to use Timewarp for localizing campaign delivery to recipients' time zones. Cannot be true when using Batch Delivery. |
Requirements
Output
json— Response from the API endpoint 'postCampaignsIdActionsSchedule'.MailchimpMarketingApi.SearchMailchimpCampaigns
Search for email campaigns using query terms. Use this tool to search all Mailchimp email campaigns that match specific query terms. This can help find campaigns based on certain criteria or keywords.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
search_query | string | Required | The terms used to filter and search Mailchimp campaigns. |
exclude_campaign_fields | string | Optional | Comma-separated list of fields to exclude from the search results. Use dot notation for sub-objects. |
included_fields | string | Optional | Specify the fields to return as a comma-separated list. Use dot notation for sub-object parameters. |
Requirements
Output
json— Response from the API endpoint 'getSearchCampaigns'.MailchimpMarketingApi.SearchMailchimpMembers
Search for Mailchimp list members across lists. Search for list members in Mailchimp. This can be restricted to a specific list or used to search across all lists in an account.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
search_query | string | Required | The search query to filter list members by email, first name, or last name. |
fields_to_exclude | string | Optional | A comma-separated list specifying which fields to exclude from results. Use dot notation for sub-object references. |
fields_to_return | string | Optional | Comma-separated list of fields to return, using dot notation for sub-objects. |
list_unique_id | string | Optional | The unique identifier for a Mailchimp list to restrict the search. Use this to specify a particular list. |
Requirements
Output
json— Response from the API endpoint 'getSearchMembers'.MailchimpMarketingApi.SearchTagsByName
Search for tags on a list by name. Use this tool to find specific tags by name within a Mailchimp list. If no name is provided, it will return all tags on the list.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
list_id | string | Required | The unique identifier for a Mailchimp list. This is essential for specifying which list to search for tags. |
tag_name_search_query | string | Optional | The prefix to filter tags by name. Returns tags where names start with this query. |
Requirements
Output
json— Response from the API endpoint 'searchTagsByName'.MailchimpMarketingApi.SendMailchimpCampaign
Send a Mailchimp campaign immediately or as scheduled. Use this tool to send a Mailchimp campaign. For RSS campaigns, it will follow the predefined schedule, while all other types of campaigns will be sent immediately.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
campaign_unique_id | string | Required | The unique identifier for the Mailchimp campaign to be sent. This is a string value required to trigger the campaign. |
Requirements
Output
json— Response from the API endpoint 'postCampaignsIdActionsSend'.MailchimpMarketingApi.SendTestEmailCampaign
Send a test email for a specific campaign. Use this tool to send a test email for a specified Mailchimp marketing campaign. Useful for previewing the campaign before final send.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
campaign_unique_id | string | Required | The unique ID for the specific Mailchimp campaign to send the test email for. |
test_email_addresses | array<string> | Required | An array of email addresses to receive the test email. |
test_email_send_type | string | Required | Specify the type of test email to send: 'html' or 'plaintext'. |
Requirements
Output
json— Response from the API endpoint 'postCampaignsIdActionsTest'.MailchimpMarketingApi.SetCampaignContent
Set the content for a campaign in Mailchimp. Use this tool to update or set the content for a specific campaign in Mailchimp. It is called when you need to change or define what content is included in a campaign. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
campaign_id | string | Optional | The unique identifier for the Mailchimp campaign to set the content for. This ID is required to specify which campaign you are updating. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'putCampaignsIdContent'.MailchimpMarketingApi.StartAutomatedEmail
Initiate an automated email in Mailchimp. Use this tool to begin sending an automated email within a specific Mailchimp workflow. Useful for starting email campaigns based on predefined automation workflows.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
automation_email_id | string | Required | The unique ID for the specific email in the automation workflow to be started. |
automation_workflow_id | string | Required | The unique identifier for the Automation workflow in Mailchimp. |
Requirements
Output
json— Response from the API endpoint 'postAutomationsIdEmailsIdActionsStart'.MailchimpMarketingApi.StartBatchProcessing
Initiate a batch operations request in Mailchimp. Use this tool to initiate processing of batch operations requests in Mailchimp Marketing. This is useful for handling multiple actions at once, such as managing email campaigns or subscriber updates. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'postBatches'.MailchimpMarketingApi.StartMailchimpAutomationEmails
Start all emails in a Mailchimp automation workflow. Use this tool to initiate all emails within a specified classic automation workflow in Mailchimp. It should be called when you want to activate a pre-configured sequence of emails in a marketing campaign.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
automation_workflow_id | string | Required | The unique identifier for the Mailchimp automation workflow to be started. |
Requirements
Output
json— Response from the API endpoint 'postAutomationsIdActionsStartAllEmails'.MailchimpMarketingApi.TriggerAutomationStep
Trigger a step in a Mailchimp automation flow. Use this tool to activate a specific step in an existing Mailchimp automation flow. It requires the journey and step IDs, which are provided during the creation process in the Customer Journey API.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
flow_id | string | Required | The unique identifier for the automation flow to trigger a specific step. |
list_member_email_address | string | Required | The email address of the list member to trigger the automation step for. |
step_identifier | string | Required | The unique identifier for the step in the Mailchimp automation flow. |
Requirements
Output
json— Response from the API endpoint 'postCustomerJourneysJourneysIdStepsIdActionsTrigger'.MailchimpMarketingApi.UnpublishLandingPage
Unpublish a draft or published landing page. Used to unpublish a landing page that is currently in draft or has been published on Mailchimp. This can be useful for managing the visibility of a page.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
landing_page_id | string | Required | The unique ID of the landing page to be unpublished. Required for identifying the specific page on Mailchimp. |
Requirements
Output
json— Response from the API endpoint 'postLandingPageIdActionsUnpublish'.MailchimpMarketingApi.UnpublishMailchimpSurvey
Unpublish a survey in Mailchimp Marketing. Use this tool to unpublish a survey that has been published in Mailchimp Marketing. This action is useful when you need to deactivate a survey for any reason.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mailchimp_list_id | string | Required | The unique ID for the Mailchimp list associated with the survey to unpublish. |
survey_id | string | Required | Enter the unique ID of the survey to unpublish in Mailchimp. |
Requirements
Output
json— Response from the API endpoint 'postListsIdSurveysIdActionsUnpublish'.MailchimpMarketingApi.UnscheduleCampaign
Unschedule a scheduled Mailchimp campaign. Use this tool to unschedule a Mailchimp campaign that is scheduled but hasn't started sending yet.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
campaign_id | string | Required | The unique identifier for the scheduled campaign to be unscheduled. |
Requirements
Output
json— Response from the API endpoint 'postCampaignsIdActionsUnschedule'.MailchimpMarketingApi.UpdateAutomationEmailSettings
Update settings for a classic automation workflow email. Use this tool to update the settings of a specific email in a classic automation workflow in Mailchimp. Applicable for workflows of type: abandonedBrowse, abandonedCart, emailFollowup, or singleWelcome. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
automation_workflow_id | string | Optional | The unique identifier for the Automation workflow to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
automation_workflow_email_id | string | Optional | The unique ID for the Automation workflow email to update. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'patchAutomationEmailWorkflowId'.MailchimpMarketingApi.UpdateBatchWebhook
Update a batch webhook on Mailchimp. Use this tool to update a webhook that triggers when a batch request in Mailchimp completes. This is useful for managing notifications and automated responses to batch operations.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
batch_webhook_unique_id | string | Required | The unique identifier for the batch webhook to update. |
enable_webhook | boolean | Optional | Enable or disable webhook requests (true for enable, false for disable). |
webhook_url | string | Optional | A valid URL to send webhook notifications when a batch request completes in Mailchimp. |
Requirements
Output
json— Response from the API endpoint 'patchBatchWebhooks'.MailchimpMarketingApi.UpdateCampaignFeedback
Update specific feedback for a Mailchimp campaign. Use this tool to update a particular feedback message for a specific Mailchimp marketing campaign. This is useful when corrections or additional details need to be added to existing feedback.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
campaign_id | string | Required | The unique identifier for the Mailchimp campaign to be updated. |
feedback_message_id | string | Required | The unique identifier for the specific feedback message to update in the campaign. |
editable_block_id | integer | Optional | The ID of the editable block that the feedback addresses within the campaign. |
feedback_is_complete | boolean | Optional | Indicates if the feedback is marked as complete. Use true for complete and false for incomplete. |
feedback_message | string | Optional | The text content of the feedback message to be updated. |
Requirements
Output
json— Response from the API endpoint 'patchCampaignsIdFeedbackId'.MailchimpMarketingApi.UpdateCampaignFolder
Update a specific folder used to organize campaigns. Use this tool to modify the details of an existing campaign folder in Mailchimp. It updates the specified folder to help organize marketing campaigns more efficiently.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
campaign_folder_id | string | Required | The unique identifier for the campaign folder to be updated. |
folder_name | string | Required | The new name to assign to the campaign folder. |
Requirements
Output
json— Response from the API endpoint 'patchCampaignFoldersId'.MailchimpMarketingApi.UpdateCampaignSettings
Update campaign settings in Mailchimp. Use this tool to modify specific settings for a given campaign in Mailchimp. Suitable for updating parts or all of a campaign's configuration. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
campaign_unique_id | string | Optional | The unique identifier for the campaign to be updated in Mailchimp. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'patchCampaignsId'.MailchimpMarketingApi.UpdateCart
Update a specific cart in an e-commerce store. This tool updates a specified cart within a given e-commerce store using the Mailchimp Marketing API. Use it to modify cart details like items, quantities, or any other attributes available. Ideal for scenarios involving cart adjustments before customer checkout. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
store_id | string | Optional | The unique identifier for the store where the cart is located. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
cart_identifier | string | Optional | The unique identifier for the cart. Used to specify which cart to update in the e-commerce store. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'patchEcommerceStoresIdCartsId'.MailchimpMarketingApi.UpdateCartLineItem
Update a specific cart line item in Mailchimp. Use this tool to modify an existing cart line item in a specified e-commerce store within Mailchimp. This can be used to adjust item details such as quantity or other attributes.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
cart_id | string | Required | The unique identifier for the cart. |
cart_line_item_id | string | Required | The unique identifier for the line item within the cart to be updated. |
store_identifier | string | Required | The unique identifier for the e-commerce store. Essential for specifying which store's cart line item to update. |
cart_line_item_price | number | Optional | The price of a cart line item to be updated. |
cart_line_item_quantity | integer | Optional | The quantity of the cart line item to update. |
product_identifier | string | Optional | A unique identifier for the product associated with the cart line item. |
product_variant_identifier | string | Optional | A unique identifier for the product variant associated with the cart line item. Required to specify which variant to update. |
Requirements
Output
json— Response from the API endpoint 'patchEcommerceStoresIdCartsIdLinesId'.MailchimpMarketingApi.UpdateContactInformation
Update information for an existing contact. Use this tool to update the details of an existing omni-channel contact in a specified audience in Mailchimp. Ideal for modifying contact information such as email, name, or other personal details. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
audience_id | string | Optional | The unique ID for the audience to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
contact_id | string | Optional | The unique ID for the contact to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
merge_field_validation_mode | string | Optional | Specifies how merge field validation is handled. Options: `ignore_required_checks` (no error if fields missing), `strict` (errors if required fields not provided). Default is `strict`. Only used when mode is 'execute'. |
data_processing_mode | string | Optional | Specify `historical` to prevent triggering automations/webhooks, or `live` to trigger them for contact data changes. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'patchAudienceContact'.MailchimpMarketingApi.UpdateCustomerInfo
Update a customer's information in an ecommerce store. Use this tool to update the information of a customer within a specific ecommerce store. Ideal for changes in customer details such as address, contact info, or other personal data. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
store_identifier | string | Optional | The unique identifier for the ecommerce store where the customer resides. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
customer_identifier | string | Optional | The unique identifier for a customer in a specific store. Required to update customer information. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'patchEcommerceStoresIdCustomersId'.MailchimpMarketingApi.UpdateEcommerceOrder
Add or update an order in an ecommerce store. Use this tool to either add a new order or update an existing order within an ecommerce store in Mailchimp Marketing. This tool is suitable when order details need to be adjusted or fresh orders are being added. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
store_identifier | string | Optional | The unique identifier for the store in which the order is being added or updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
order_identifier | string | Optional | The unique identifier for the order in the store. Used to specify which order to update or add. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'putEcommerceStoresIdOrdersId'.MailchimpMarketingApi.UpdateEcommerceProduct
Update a specific product in an ecommerce store. Use this tool to update details of a specific product in an ecommerce store. It is useful when you need to modify product information such as pricing, inventory, or descriptions. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
store_identifier | string | Optional | The unique identifier of the store to update the product in. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
product_id | string | Optional | The unique identifier for the product within a store. This is used to specify which product needs to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'putEcommerceStoresIdProductsId'.MailchimpMarketingApi.UpdateEcommerceStore
Update an e-commerce store's details. This tool is used to update the information of an existing e-commerce store in Mailchimp. Call this when you need to modify store details, such as the store name or other attributes. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
store_identifier | string | Optional | The unique identifier for the store you want to update. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'patchEcommerceStoresId'.MailchimpMarketingApi.UpdateEmailTemplate
Update the details of an existing email template. Use this tool to update the name, HTML content, or folder ID of an existing email template in Mailchimp.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
template_html_content | string | Required | The raw HTML for the template using Mailchimp's Template Language. |
template_name | string | Required | The name of the email template to update. |
template_unique_id | string | Required | The unique identifier for the email template to be updated. |
destination_folder_id | string | Optional | The ID of the folder where the template is currently located. |
Requirements
Output
json— Response from the API endpoint 'patchTemplatesId'.MailchimpMarketingApi.UpdateFileManagerFile
Update a file in the Mailchimp File Manager. Use this tool to update an existing file in Mailchimp's File Manager by providing the file ID. It is useful for changing file details or replacing content.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
file_manager_file_id | string | Required | The unique identifier for the File Manager file to be updated. |
file_name | string | Optional | Specify the new name for the file in the File Manager. |
folder_id | integer | Optional | The ID of the folder. Set to `0` to remove a file from its current folder. |
Requirements
Output
json— Response from the API endpoint 'patchFileManagerFilesId'.MailchimpMarketingApi.UpdateFileManagerFolder
Update a specific File Manager folder in Mailchimp. Use this tool to update the details of a specific folder in Mailchimp's File Manager. Useful for organizing files within the platform.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
file_manager_folder_id | string | Required | The unique identifier for the File Manager folder to update. |
folder_name | string | Required | The new name for the File Manager folder. It should be a string value. |
Requirements
Output
json— Response from the API endpoint 'patchFileManagerFoldersId'.MailchimpMarketingApi.UpdateInterestCategory
Update a specific interest category in Mailchimp. Use this tool to update the details of a specific interest category within a Mailchimp list. Ideal for modifying category information to better organize your audience.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
category_display_type | string | Required | Specifies how the category's interests are shown on signup forms. Options: 'checkboxes', 'dropdown', 'radio', 'hidden'. |
interest_category_id | string | Required | The unique ID for the interest category to be updated. |
interest_category_title | string | Required | The text description of this interest category for signup forms, often phrased as a question. |
list_unique_id | string | Required | The unique identifier for the Mailchimp list to be updated. |
category_display_order | integer | Optional | The numerical order for displaying the category. Lower numbers appear first. |
Requirements
Output
json— Response from the API endpoint 'patchListsIdInterestCategoriesId'.MailchimpMarketingApi.UpdateInterestGroupName
Update group names in a specific interest category. Use this tool to update the names of interest groups within a specified category on a Mailchimp list. This is helpful for managing and organizing subscriber interests.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
interest_category_id | string | Required | The unique ID for the interest category to be updated. |
interest_group_name | string | Required | The new name for the interest group, displayed publicly on subscription forms. |
list_unique_id | string | Required | The unique ID for the list to be updated. |
specific_interest_id | string | Required | The unique ID for the specific interest group name within the category. |
interest_display_order | integer | Optional | The numerical order in which the interest should appear in a list. |
Requirements
Output
json— Response from the API endpoint 'patchListsIdInterestCategoriesIdInterestsId'.MailchimpMarketingApi.UpdateLandingPage
Update a landing page on Mailchimp. Use this tool to update an existing landing page on Mailchimp. Provide the necessary details for the landing page you wish to update.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
landing_page_id | string | Required | The unique ID for the landing page to be updated. |
enable_restricted_data_processing | boolean | Optional | Set to true to enable Google’s restricted data processing in compliance with the CCPA for this landing page. |
enable_tracking_with_mailchimp | boolean | Optional | Enable cookie tracking to monitor unique visitors and calculate conversion rates. More info: [here](https://mailchimp.com/help/use-track-mailchimp/). |
landing_page_description | string | Optional | Provide a description for the landing page. This text summarizes the page's purpose and content. |
landing_page_name | string | Optional | The name for the landing page to be updated. |
landing_page_title | string | Optional | The title displayed in the browser's title bar for the landing page. |
list_id_for_landing_page | string | Optional | The ID of the list associated with this landing page. |
store_id | string | Optional | The ID of the store associated with this landing page. It must match an existing store in the Mailchimp account. |
Requirements
Output
json— Response from the API endpoint 'patchLandingPageId'.MailchimpMarketingApi.UpdateListMemberInfo
Update information for a specific list member in Mailchimp. Use this tool to update the details of a particular member on a Mailchimp list. It should be called when you need to modify any member's information, such as their email address or other personal details, within a given list. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
list_unique_id | string | Optional | The unique ID for the Mailchimp list. This ID identifies which list to update the member information in. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
member_identifier | string | Optional | The MD5 hash of the lowercase list member's email, email address, or contact_id. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
skip_merge_validation | string | Optional | Set to true to allow member data without merge field values, even if usually required. Defaults to false. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'patchListsIdMembersId'.MailchimpMarketingApi.UpdateListMemberTags
Add or remove tags from a Mailchimp list member. Use this tool to manage tags for a specific member in a Mailchimp list. It allows adding new tags or removing existing ones. If a non-existent tag is added and marked as 'active', it will be created automatically. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
list_unique_id | string | Optional | The unique ID for the Mailchimp list to update tags for a member. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
subscriber_email_hash | string | Optional | The MD5 hash of the lowercase version of the list member's email address. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'postListMemberTags'.MailchimpMarketingApi.UpdateListSegment
Batch update members in a Mailchimp list segment. Use this tool to batch add or remove members in a specified static segment of a Mailchimp list. This is useful for efficiently managing segment membership within a list.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
list_unique_id | string | Required | The unique identifier for the Mailchimp list. |
segment_unique_id | string | Required | The unique ID of the segment in the Mailchimp list for member updates. |
emails_to_add_to_segment | array<string> | Optional | An array of email addresses to add to the specified static segment. Only existing list emails will be added. Limit of 500. |
emails_to_remove_from_segment | array<string> | Optional | An array of up to 500 emails to remove from the static segment. Emails not in the list will be ignored. |
Requirements
Output
json— Response from the API endpoint 'postListsIdSegmentsId'.MailchimpMarketingApi.UpdateMailchimpListSettings
Update settings for a specific Mailchimp list. Use this tool to modify the settings of a specific list in Mailchimp. It should be called when you need to update a list's configuration or preferences. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
mailchimp_list_id | string | Optional | The unique ID of the Mailchimp list to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'patchListsId'.MailchimpMarketingApi.UpdateMailchimpSegment
Update the details of a specific segment in a Mailchimp list. This tool updates a specific segment within a designated list in Mailchimp. It should be called when there is a need to modify segment criteria or details in an existing list.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
list_unique_id | string | Required | The unique ID for the list to update the segment in. This ID is required to identify the list containing the target segment. |
segment_name | string | Required | The new name for the segment to be updated. |
segment_unique_id | string | Required | The unique ID for the segment to update. |
segment_conditions | array<json> | Optional | An array of conditions that define the segment criteria. Each condition should be a JSON object specifying the targeting parameters. |
segment_match_type | string | Optional | Determines if any or all conditions must be met for the segment. Allowed values: 'any', 'all'. |
static_email_list | array<string> | Optional | An array of emails for the static segment. Emails not on the list are ignored. An empty array resets the segment, removing all members. Cannot be used with 'options'. |
Requirements
Output
json— Response from the API endpoint 'patchListsIdSegmentsId'.MailchimpMarketingApi.UpdateMemberNote
Update a specific note for a list member in Mailchimp. This tool updates a specific note for a given list member on Mailchimp. Use this when you need to modify the content of an existing note associated with a subscriber in a mailing list.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
list_unique_id | string | Required | The unique ID for the mailing list where the note is being updated. |
member_identifier | string | Required | The MD5 hash, email address, or contact_id of the list member. |
note_identifier | string | Required | The unique identifier for the note to be updated. |
note_content | string | Optional | Content of the note to be updated. Must not exceed 1,000 characters. |
Requirements
Output
json— Response from the API endpoint 'patchListsIdMembersIdNotesId'.MailchimpMarketingApi.UpdateMergeField
Update a specific merge field in a list. This tool updates a specific merge field for a given list in Mailchimp. Use it when you need to modify the properties of a merge field, such as its name or type, within a specific list. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
list_id | string | Optional | The unique ID for the list to update the merge field in. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
merge_field_id | string | Optional | The unique ID for the specific merge field to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'patchListsIdMergeFieldsId'.MailchimpMarketingApi.UpdateOrderLineItem
Update a specific order line item. Use this tool to update details of a specific order line item in an e-commerce store. Useful for modifying existing order line items with new information or adjustments.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
line_item_id | string | Required | The unique identifier for the line item within an order in a store. |
order_id | string | Required | The unique identifier for the order within the store. Required to specify which order is being updated. |
store_identifier | string | Required | Unique identifier for the store where the order was placed. |
line_item_discount_amount | number | Optional | The total discount amount applied to this line item in the order. Provide as a numerical value. |
order_line_item_price | number | Optional | Specify the updated price for the order line item. This should be a numerical value reflecting the new cost of the item. |
order_line_item_quantity | integer | Optional | Specify the quantity of the order line item to be updated. |
product_identifier | string | Optional | A unique identifier for the product associated with the order line item. |
product_variant_id | string | Optional | A unique identifier for the product variant associated with the order line item. This is required to specify the variant of the product being referenced. |
Requirements
Output
json— Response from the API endpoint 'patchEcommerceStoresIdOrdersIdLinesId'.MailchimpMarketingApi.UpdateOrderMailchimp
Update a specific order in Mailchimp's e-commerce store. Use this tool to modify order details in a specified Mailchimp e-commerce store. It updates the order data based on provided criteria and returns the updated order status. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
store_identifier | string | Optional | The unique identifier for the store in which the order is being updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
order_id | string | Optional | The unique identifier for the order in the store that needs to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'patchEcommerceStoresIdOrdersId'.MailchimpMarketingApi.UpdateProductImageMailchimp
Update a product image in an e-commerce store. This tool updates a specific product image within a Mailchimp e-commerce store. Use it when you need to modify an image associated with a product in a store managed by Mailchimp.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
product_identifier | string | Required | The unique identifier for a product in the store. Used to specify which product's image should be updated. |
product_image_id | string | Required | The unique identifier for the product image to update. |
store_id | string | Required | The unique identifier for the e-commerce store. |
product_image_unique_id | string | Optional | A unique identifier for a specific product image to be updated in the store. |
product_image_url | string | Optional | The URL of the product image to be updated. |
variant_ids | array<string> | Optional | A list of product variant IDs associated with the image. Each variant ID should be a string. |
Requirements
Output
json— Response from the API endpoint 'patchEcommerceStoresIdProductsIdImagesId'.MailchimpMarketingApi.UpdateProductInfo
Update details of a specific product in a store. This tool updates information for a specific product in an e-commerce store. Call this tool when you need to modify product details, such as name, description, or price, for a particular store. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
store_identifier | string | Optional | The identifier for the specific store whose product details are being updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
product_identifier | string | Optional | The unique identifier for the product within a store. Required for updating product details. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'patchEcommerceStoresIdProductsId'.MailchimpMarketingApi.UpdateProductVariant
Add or update a product variant in an ecommerce store. Use this tool to add a new product variant or update an existing one in a specified ecommerce store. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
store_identifier | string | Optional | The unique identifier for the ecommerce store. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
product_identifier | string | Optional | The unique identifier for the product in the store. This ID is used to specify which product's variant is being added or updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
product_variant_id | string | Optional | The unique identifier for the product variant to be updated or added. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'putEcommerceStoresIdProductsIdVariantsId'.MailchimpMarketingApi.UpdatePromoCode
Update details of a specific promo code. Use this tool to update the details of a specific promo code in an eCommerce store using Mailchimp. It should be called when you need to modify existing promotional codes, such as changing the discount or expiration date.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
promo_code_identifier | string | Required | The unique identifier for the promo code of a store. |
promo_rule_identifier | string | Required | The identifier for the promo rule in a store. Used to specify which promotional rule to update. |
store_identifier | string | Required | The unique identifier for the eCommerce store in Mailchimp. |
discount_code | string | Optional | The discount code for the promo. Must be UTF-8 and up to 50 characters. |
is_promo_code_enabled | boolean | Optional | Set to true to enable the promo code, or false to disable it. |
promo_code_usage_count | integer | Optional | Specifies how many times the promo code has been used. Accepts an integer value. |
promotion_created_at | string | Optional | The promotion creation date and time in ISO 8601 format. |
promotion_redemption_url | string | Optional | The URL for the promotion campaign. Must be UTF-8, max 2000 characters. |
promotion_update_timestamp | string | Optional | The timestamp when the promotion was updated, in ISO 8601 format. This indicates the last update time of the promo code details. |
Requirements
Output
json— Response from the API endpoint 'patchEcommerceStoresIdPromocodesId'.MailchimpMarketingApi.UpdatePromoRule
Update a promotional rule in an e-commerce store. Use this tool to modify details of an existing promotional rule in a specified e-commerce store. It should be called when you need to update the conditions or discounts associated with a promo rule. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
store_identifier | string | Optional | Specify the unique identifier of the e-commerce store where the promo rule will be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
promo_rule_identifier | string | Optional | The unique identifier for the promotional rule within the store. This is required to specify which promo rule to update. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'patchEcommerceStoresIdPromorulesId'.MailchimpMarketingApi.UpdateTemplateFolder
Update a specific folder for organizing templates. This tool updates a specific folder used to organize templates in Mailchimp. It should be called when you need to change the details of a template folder, identified by its ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
folder_name | string | Required | The new name for the template folder. Provide a string value. |
template_folder_id | string | Required | The unique identifier for the template folder to be updated. |
Requirements
Output
json— Response from the API endpoint 'patchTemplateFoldersId'.MailchimpMarketingApi.UpdateWebhookSettings
Update the settings for an existing webhook. Use this tool to modify the configuration of a specific webhook linked to a mailing list. This is useful for changing how the webhook operates without creating a new one. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
list_id | string | Optional | The unique identifier for the mailing list associated with the webhook. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
webhook_identifier | string | Optional | The unique identifier for the webhook to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'patchListsIdWebhooksId'.MailchimpMarketingApi.UploadFileToFileManager
Upload a new file or image to the File Manager. Use this tool to upload files or images to the File Manager, enhancing content management.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
file_content_base64 | string | Required | The base64-encoded contents of the file to be uploaded. |
file_name | string | Required | The name to be assigned to the uploaded file. |
folder_id | integer | Optional | The ID of the folder where the file will be uploaded. This should be an integer. |
Requirements
Output
json— Response from the API endpoint 'postFileManagerFiles'.MailchimpMarketingApi.VerifyScriptInstallation
Verify if the Mailchimp connected site script is installed. This tool checks if a Mailchimp connected site's script has been correctly installed using the script URL or fragment. Use it to confirm script deployment.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
site_unique_identifier | string | Required | The unique identifier for the Mailchimp connected site to verify script installation. |
Requirements
Output
json— Response from the API endpoint 'postConnectedSitesIdActionsVerifyScriptInstallation'.MailchimpMarketingApi.VerifySendingDomain
Verify if a domain is authorized for sending emails. Use this tool to verify whether a specific domain is authorized for sending emails through Mailchimp. It should be called when you need to confirm the sending capabilities of a domain.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
domain_name_to_verify | string | Required | The domain name you wish to verify for sending emails through Mailchimp. |
verification_code | string | Required | The code sent to the provided email address for domain verification. |
Requirements
Output
json— Response from the API endpoint 'verifyDomain'.