### Start Product Variant Source: https://mailchimp.com/developer/marketing/api/ecommerce-product-variants/get-product-variant-info Starts a product variant. ```APIDOC ## Start Product Variant ### Description Start an automated email. ### Method POST ### Endpoint /automations/{workflow_id}/emails/{workflow_email_id}/actions/start ``` -------------------------------- ### List recent activity Source: https://mailchimp.com/developer/marketing/api/conversations/list-conversations Get recent daily, aggregated activity stats for your list. For example, view unsubscribes, signups, total emails sent, opens, clicks, and more, for up to 180 days. ```APIDOC ## List recent activity Get up to the previous 180 days of daily detailed aggregated activity stats for a list, not including Automation activity. ### Method GET ### Endpoint /lists/{list_id}/activity ``` -------------------------------- ### Verify Connected Site Script Installation Source: https://mailchimp.com/developer/marketing/api/connected-sites/list-connected-sites Use this endpoint to verify that the connected site's script has been installed. ```HTTP post /connected-sites/{connected_site_id}/actions/verify-script-installation ``` -------------------------------- ### List recent activity Source: https://mailchimp.com/developer/marketing/api/connected-sites Get recent daily, aggregated activity stats for your list. For example, view unsubscribes, signups, total emails sent, opens, clicks, and more, for up to 180 days. ```APIDOC ## List recent activity ### Description Get up to the previous 180 days of daily detailed aggregated activity stats for a list, not including Automation activity. ### Method GET ### Endpoint /lists/{list_id}/activity ``` -------------------------------- ### Get account export info Source: https://mailchimp.com/developer/marketing/api/account-exports/get-account-export-info Retrieves information about a specific account export using its unique ID. This includes details such as the export ID, start and finish times, size, and download URL if available. ```APIDOC ## GET /account-exports/{export_id} ### Description Get information about a specific account export. ### Method GET ### Endpoint /account-exports/{export_id} ### Parameters #### Path Parameters - **export_id** (string) - Required - The unique id for the account export. #### Query Parameters - **fields** (string[]) - Optional - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. - **exclude_fields** (string[]) - Optional - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. ### Response #### Success Response (200) An account export. - **export_id** (integer) - The ID for the export. - **started** (string) - Start time for the export. - **finished** (string) - If finished, the finish time for the export. - **size_in_bytes** (integer) - The size of the uncompressed export in bytes. - **download_url** (string) - If the export is finished, the download URL for an export. URLs are only valid for 90 days after the export completes. - **_links** (object[]) - A list of link types and descriptions for the API schema documents. #### Response Example ```json { "export_id": 0, "started": "2019-08-24T14:15:22Z", "finished": "2019-08-24T14:15:22Z", "size_in_bytes": 0, "download_url": "string", "_links": [ { "rel": "string", "href": "string", "method": "GET", "targetSchema": "string", "schema": "string" } ] } ``` ### Error Response #### Problem Detail Document An error generated by the Mailchimp API. - **type** (string) - An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. - **title** (string) - A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. - **status** (integer) - The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. - **detail** (string) - A human-readable explanation specific to this occurrence of the problem. Learn more about errors. - **instance** (string) - A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. ### Example error response ```json { "type": "https://mailchimp.com/developer/marketing/docs/errors/", "title": "Resource Not Found", "status": 404, "detail": "The requested resource could not be found.", "instance": "995c5cb0-3280-4a6e-808b-3b096d0bb219" } ``` ``` -------------------------------- ### Add product Source: https://mailchimp.com/developer/marketing/api/authorized-apps Add a new product to a store. ```APIDOC ## POST /ecommerce/stores/{store_id}/products ### Description Add a new product to a store. ### Method POST ### Endpoint /ecommerce/stores/{store_id}/products ``` -------------------------------- ### Create a campaign folder Source: https://mailchimp.com/developer/marketing/api/campaign-folders/get-campaign-folder Create a new campaign folder. ```APIDOC ## Create a campaign folder ### Description Create a new campaign folder. ### Method POST ### Endpoint /campaign-folders ### Request Body - **name** (string) - Required - The name of the campaign folder. ``` -------------------------------- ### Example Success Response - Account Export Source: https://mailchimp.com/developer/marketing/api/account-exports/add-export This JSON structure represents a successful response when creating an account export. It includes the export ID, start and finish times, size, and a download URL if the export is complete. ```json { "export_id": 0, "started": "2019-08-24T14:15:22Z", "finished": "2019-08-24T14:15:22Z", "size_in_bytes": 0, "download_url": "string", "_links": [ { "rel": "string", "href": "string", "method": "GET", "targetSchema": "string", "schema": "string" } ] } ``` -------------------------------- ### Create a campaign folder Source: https://mailchimp.com/developer/marketing/api/campaign-folders/update-campaign-folder Create a new campaign folder to organize your campaigns. ```APIDOC ## Create a campaign folder ### Description Create a new campaign folder to organize your campaigns. ### Method POST ### Endpoint /campaign-folders ### Request Body - **name** (string) - Required - The name of the folder. ### Request Example { "name": "My New Folder" } ### Response #### Success Response (200) - **folder_id** (string) - The unique identifier for the newly created folder. - **name** (string) - The name of the folder. - **created_at** (string) - The date and time the folder was created. - **updated_at** (string) - The date and time the folder was last updated. ``` -------------------------------- ### Create a campaign folder Source: https://mailchimp.com/developer/marketing/api/campaign-folders/list-campaign-folders Create a new campaign folder to organize your campaigns. ```APIDOC ## Create a campaign folder ### Description Create a new campaign folder to organize your campaigns. ### Method POST ### Endpoint /campaign-folders ### Request Body - **name** (string) - Required - The name of the new campaign folder. ### Request Example { "name": "My New Folder" } ### Response #### Success Response (200) - **name** (string) - The name of the newly created folder. - **folder_id** (string) - The unique identifier for the folder. - **count** (integer) - The number of campaigns in the folder. - **_links** (array) - Links to related resources. ``` -------------------------------- ### Start automated email Source: https://mailchimp.com/developer/marketing/api/account-exports/add-export Start an automated email. ```APIDOC ## Start automated email ### Description Start an automated email. ### Method POST ### Endpoint /automations/{workflow_id}/emails/{workflow_email_id}/actions/start ``` -------------------------------- ### Add product Source: https://mailchimp.com/developer/marketing/api/abuse-reports/list-abuse-reports Add a new product to a store. Each product requires at least one product variant. ```APIDOC ## Add product ### Description Add a new product to a store. Each product requires at least one product variant. ### Method POST ### Endpoint /ecommerce/stores/{store_id}/products ``` -------------------------------- ### Start automated email Source: https://mailchimp.com/developer/marketing/api/authorized-apps Start an automated email. ```APIDOC ## POST /automations/{workflow_id}/emails/{workflow_email_id}/actions/start ### Description Start an automated email. ### Method POST ### Endpoint /automations/{workflow_id}/emails/{workflow_email_id}/actions/start ``` -------------------------------- ### Get survey Source: https://mailchimp.com/developer/marketing/api/account-exports/add-export Get details about a specific survey. ```APIDOC ## Get survey ### Description Get details about a specific survey. ### Method GET ### Endpoint /lists/{list_id}/surveys/{survey_id} ``` -------------------------------- ### Add product Source: https://mailchimp.com/developer/marketing/api/campaign-abuse Adds a new product to a store. ```APIDOC ## POST /ecommerce/stores/{store_id}/products ### Description Add a new product to a store. ### Method POST ### Endpoint /ecommerce/stores/{store_id}/products ### Parameters #### Path Parameters - **store_id** (string) - Required - The ID of the store. #### Request Body - **product** (object) - Required - The details of the product to add. ``` -------------------------------- ### Get survey Source: https://mailchimp.com/developer/marketing/api/automation/get-automation-info Get details about a specific survey. ```APIDOC ## Get survey ### GET /lists/{list_id}/surveys/{survey_id} #### Description Get details about a specific survey. #### Endpoint `/lists/{list_id}/surveys/{survey_id}` ``` -------------------------------- ### Verify connected site script installation Source: https://mailchimp.com/developer/marketing/api/connected-sites/list-connected-sites Verify that the connected sites script has been installed, either via the script URL or fragment. ```APIDOC ## POST /connected-sites/{connected_site_id}/actions/verify-script-installation ### Description Verify that the connected sites script has been installed, either via the script URL or fragment. ### Method POST ### Endpoint /connected-sites/{connected_site_id}/actions/verify-script-installation ### Parameters #### Path Parameters - **connected_site_id** (string) - Required - The ID of the connected site. ``` -------------------------------- ### Get cart info Source: https://mailchimp.com/developer/marketing/api/connected-sites/list-connected-sites Get information about a specific cart. ```APIDOC ## GET /ecommerce/stores/{store_id}/carts/{cart_id} ### Description Get information about a specific cart. ### Method GET ### Endpoint /ecommerce/stores/{store_id}/carts/{cart_id} ### Parameters #### Path Parameters - **store_id** (string) - Required - The ID of the store. - **cart_id** (string) - Required - The ID of the cart. ### Response #### Success Response (200) - **cart** (object) - Information about the cart. ``` -------------------------------- ### Create campaign folder Source: https://mailchimp.com/developer/marketing/api/campaign-folders Create a new campaign folder. ```APIDOC ## Create campaign folder ### Description Create a new campaign folder. ### Method POST ### Endpoint /campaign-folders ### Request Body - **name** (string) - Required - The name of the folder. ``` -------------------------------- ### Add product Source: https://mailchimp.com/developer/marketing/api/campaigns/send-campaign Add a new product to a store. Requires store ID. ```APIDOC ## POST /ecommerce/stores/{store_id}/products ### Description Add a new product to a store. ### Method POST ### Endpoint /ecommerce/stores/{store_id}/products #### Path Parameters - **store_id** (string) - Required - The ID of the store. ``` -------------------------------- ### Get audience info Source: https://mailchimp.com/developer/marketing/api/conversations/get-conversation Get information about a specific audience. ```APIDOC ## GET /audiences/{audience_id} ### Description Get information about a specific audience. ### Method GET ### Endpoint /audiences/{audience_id} ### Parameters #### Path Parameters - **audience_id** (string) - Required - The ID of the audience to retrieve. ``` -------------------------------- ### Verify Connected Site Script Installation Source: https://mailchimp.com/developer/marketing/api/connected-sites/verify-connected-site-script Use this method to verify that the connected sites script has been installed for a given connected site ID. This is typically done after adding a new connected site. ```javascript const client = require("@mailchimp/mailchimp_marketing"); client.setConfig({ apiKey: "YOUR_API_KEY", server: "YOUR_SERVER_PREFIX", }); const run = async () => { const response = await client.connectedSites.verifyScriptInstallation( "connected_site_id" ); console.log(response); }; run(); ``` -------------------------------- ### Get a list of audiences Source: https://mailchimp.com/developer/marketing/api/conversations/get-conversation Get information about all audiences in the account. ```APIDOC ## GET /audiences ### Description Get information about all audiences in the account. ### Method GET ### Endpoint /audiences ``` -------------------------------- ### Add Customer Source: https://mailchimp.com/developer/marketing/api/batch-webhooks/add-batch-webhook Add a new customer to a store. ```APIDOC ## Add Customer ### Description Add a new customer to a store. ### Method POST ### Endpoint /ecommerce/stores/{store_id}/customers ``` -------------------------------- ### Get a List of Audiences Source: https://mailchimp.com/developer/marketing/api/click-reports/list-campaign-details Get information about all audiences in the account. ```APIDOC ## GET /audiences ### Description Get information about all audiences in the account. ### Method GET ### Endpoint /audiences ### Response #### Success Response (200) - **field** (type) - Description of the field ``` -------------------------------- ### Add customer Source: https://mailchimp.com/developer/marketing/api/audiences-contacts Add a new customer to a store. ```APIDOC ## Add customer ### Description Add a new customer to a store. ### Method POST ### Endpoint /ecommerce/stores/{store_id}/customers ``` -------------------------------- ### Get Audience Info Source: https://mailchimp.com/developer/marketing/api/campaigns Get information about a specific audience. ```APIDOC ## GET /audiences/{audience_id} ### Description Get information about a specific audience. ### Method GET ### Endpoint /audiences/{audience_id} ### Parameters #### Path Parameters - **audience_id** (string) - Required - The ID of the audience. ``` -------------------------------- ### Add customer Source: https://mailchimp.com/developer/marketing/api/audiences-contacts/archive-contact Add a new customer to a store. ```APIDOC ## Add customer ### Description Add a new customer to a store. ### Method POST ### Endpoint /ecommerce/stores/{store_id}/customers ``` -------------------------------- ### Get a List of Audiences Source: https://mailchimp.com/developer/marketing/api/chimp-chatter Get information about all audiences in the account. ```APIDOC ## GET /audiences ### Description Get information about all audiences in the account. ### Method GET ### Endpoint /audiences ### Parameters None ### Response #### Success Response (200) - Information about all audiences in the account. ``` -------------------------------- ### List product Source: https://mailchimp.com/developer/marketing/api/campaign-abuse Retrieves information about all products within a store. ```APIDOC ## GET /ecommerce/stores/{store_id}/products ### Description Get information about a store's products. ### Method GET ### Endpoint /ecommerce/stores/{store_id}/products ### Parameters #### Path Parameters - **store_id** (string) - Required - The ID of the store. #### Response #### Success Response (200) - **products** (array) - A list of product objects. ``` -------------------------------- ### Get segment info Source: https://mailchimp.com/developer/marketing/api/campaign-checklist Get information about a specific segment. ```APIDOC ## GET /lists/{list_id}/segments/{segment_id} ### Description Get information about a specific segment. ### Method GET ### Endpoint /lists/{list_id}/segments/{segment_id} ### Parameters #### Path Parameters - **list_id** (string) - Required - The unique ID for the list. - **segment_id** (string) - Required - The unique ID for the segment. ### Response #### Success Response (200) - **id** (string) - The ID of the segment. - **name** (string) - The name of the segment. - **list_id** (string) - The ID of the list. - **member_count** (integer) - The number of members in the segment. - **_links** (array) - Links to related resources. ``` -------------------------------- ### Get order info Source: https://mailchimp.com/developer/marketing/api/campaigns/cancel-campaign Get information about a specific order. ```APIDOC ## GET /ecommerce/stores/{store_id}/orders/{order_id} ### Description Get information about a specific order. ### Method GET ### Endpoint /ecommerce/stores/{store_id}/orders/{order_id} ### Parameters #### Path Parameters - **store_id** (string) - Required - The ID of the store. - **order_id** (string) - Required - The ID of the order. ```