{"componentChunkName":"component---src-pages-product-js","path":"/marketing/api/","result":{"data":{"productData":{"name":"Mailchimp Marketing API","sidenavTitle":null,"firstGuide":{"fields":{"path":"/marketing/guides/quick-start"}},"guides":[{"slug":"quick-start","headline":"Marketing API Quick Start","contentList":[{"title":"At a glance","shouldHideFromSidebar":true},{"title":"Create an account","shouldHideFromSidebar":false},{"title":"Generate your API key","shouldHideFromSidebar":false},{"title":"Install the client library for your language","shouldHideFromSidebar":false},{"title":"Make your first API call","shouldHideFromSidebar":false},{"title":"Next steps","shouldHideFromSidebar":false}]},{"slug":"create-your-first-audience","headline":"Create Your First Audience","contentList":[{"title":"At a glance","shouldHideFromSidebar":true},{"title":"What you’ll need","shouldHideFromSidebar":true},{"title":"Create an audience","shouldHideFromSidebar":false},{"title":"Add a contact to an audience","shouldHideFromSidebar":false},{"title":"Check a contact’s subscription status","shouldHideFromSidebar":false},{"title":"Unsubscribe a contact from your audience","shouldHideFromSidebar":false},{"title":"More resources","shouldHideFromSidebar":true}]},{"slug":"organize-contacts-with-tags","headline":"Organize Contacts with Tags","contentList":[{"title":"At a glance","shouldHideFromSidebar":true},{"title":"What you’ll need","shouldHideFromSidebar":true},{"title":"Label a contact with a tag","shouldHideFromSidebar":false},{"title":"View a contact’s tags","shouldHideFromSidebar":false},{"title":"Remove a tag","shouldHideFromSidebar":false},{"title":"Bulk tagging","shouldHideFromSidebar":false},{"title":"More resources","shouldHideFromSidebar":true}]},{"slug":"access-user-data-oauth-2","headline":"Access Data on Behalf of Other Users with OAuth 2","contentList":[{"title":"At a glance","shouldHideFromSidebar":true},{"title":"What you’ll need","shouldHideFromSidebar":true},{"title":"When not to use OAuth 2","shouldHideFromSidebar":false},{"title":"OAuth 2 workflow overview","shouldHideFromSidebar":false},{"title":"Register your application","shouldHideFromSidebar":false},{"title":"Implement the OAuth 2 workflow on your server","shouldHideFromSidebar":false},{"title":"Rotate client secret","shouldHideFromSidebar":false},{"title":"More resources","shouldHideFromSidebar":true}]},{"slug":"run-async-requests-batch-endpoint","headline":"Run Async Requests with the Batch Endpoint","contentList":[{"title":"At a glance","shouldHideFromSidebar":true},{"title":"What you’ll need","shouldHideFromSidebar":true},{"title":"Make a batch operations request","shouldHideFromSidebar":false},{"title":"Check the status of a batch operation","shouldHideFromSidebar":false},{"title":"Get the results of a batch operation","shouldHideFromSidebar":false},{"title":"Batch webhooks","shouldHideFromSidebar":false},{"title":"More resources","shouldHideFromSidebar":true}]},{"slug":"track-outside-activity-events","headline":"Track Outside Activity with Events","contentList":[{"title":"At a glance","shouldHideFromSidebar":true},{"title":"What you’ll need","shouldHideFromSidebar":true},{"title":"Create an event","shouldHideFromSidebar":false},{"title":"View a contact’s events","shouldHideFromSidebar":false},{"title":"Trigger automations with events","shouldHideFromSidebar":false},{"title":"Create segments with events","shouldHideFromSidebar":false},{"title":"More resources","shouldHideFromSidebar":true}]},{"slug":"sync-audience-data-webhooks","headline":"Synchronize Audience Data with Webhooks","contentList":[{"title":"At a glance","shouldHideFromSidebar":true},{"title":"What you’ll need","shouldHideFromSidebar":true},{"title":"Set up your callback URL","shouldHideFromSidebar":false},{"title":"Create a new webhook","shouldHideFromSidebar":false},{"title":"Handling the webhook response in your application","shouldHideFromSidebar":false},{"title":"Test the webhook","shouldHideFromSidebar":false},{"title":"More resources","shouldHideFromSidebar":true}]},{"slug":"mobile-sdk","headline":"Manage Contacts and Events with the Mobile SDK","contentList":[{"title":"At a glance","shouldHideFromSidebar":true},{"title":"What you’ll need","shouldHideFromSidebar":true},{"title":"Set up the SDK for your audience","shouldHideFromSidebar":false},{"title":"Add a contact","shouldHideFromSidebar":false},{"title":"Update a contact with new information","shouldHideFromSidebar":false},{"title":"Add events based on contact activity","shouldHideFromSidebar":false},{"title":"More resources","shouldHideFromSidebar":true}]},{"slug":"create-webhook-customer-journey-builder-campaign-manager","headline":"Create a Webhook for Customer Journey Builder or Campaign Manager","contentList":[{"title":"At a glance","shouldHideFromSidebar":true},{"title":"What you’ll need","shouldHideFromSidebar":true},{"title":"Create a Customer Journey builder webhook","shouldHideFromSidebar":false},{"title":"Create a Campaign Manager webhook","shouldHideFromSidebar":false},{"title":"Troubleshooting","shouldHideFromSidebar":false}]}],"firstDoc":{"fields":{"path":"/marketing/docs/fundamentals"}},"docs":[{"slug":"fundamentals","headline":"Fundamentals","contentSource":"Contentful","markdownSourceNode":null,"contentList":[{"title":"The basics","shouldHideFromSidebar":false},{"title":"API structure","shouldHideFromSidebar":false},{"title":"Connecting to the API","shouldHideFromSidebar":false},{"title":"API limits","shouldHideFromSidebar":false}]},{"slug":"methods-parameters","headline":"Methods and Parameters","contentSource":"Contentful","markdownSourceNode":null,"contentList":[{"title":"The basics","shouldHideFromSidebar":false},{"title":"HTTP methods","shouldHideFromSidebar":false},{"title":"Path parameters","shouldHideFromSidebar":false},{"title":"Query string parameters","shouldHideFromSidebar":false}]},{"slug":"merge-fields","headline":"Merge Fields","contentSource":"Contentful","markdownSourceNode":null,"contentList":[{"title":"The basics","shouldHideFromSidebar":false},{"title":"Structure","shouldHideFromSidebar":false},{"title":"Create a merge field","shouldHideFromSidebar":false},{"title":"Add merge data to contacts","shouldHideFromSidebar":false}]},{"slug":"alternative-schemas","headline":"Alternative Schemas","contentSource":"Contentful","markdownSourceNode":null,"contentList":[{"title":"The basics","shouldHideFromSidebar":false},{"title":"Structure","shouldHideFromSidebar":false},{"title":"Activity schemas","shouldHideFromSidebar":false},{"title":"Segment condition schemas","shouldHideFromSidebar":false}]},{"slug":"e-commerce","headline":"E-Commerce","contentSource":"Contentful","markdownSourceNode":null,"contentList":[{"title":"The basics","shouldHideFromSidebar":false},{"title":"Stores","shouldHideFromSidebar":false},{"title":"Customers","shouldHideFromSidebar":false},{"title":"Products","shouldHideFromSidebar":false},{"title":"Carts","shouldHideFromSidebar":false},{"title":"Orders","shouldHideFromSidebar":false},{"title":"Order notifications","shouldHideFromSidebar":false},{"title":"Tracking and reports","shouldHideFromSidebar":false},{"title":"Product recommendations","shouldHideFromSidebar":false},{"title":"Pausing store automations","shouldHideFromSidebar":false}]},{"slug":"account-exports","headline":"Account Exports","contentSource":"Contentful","markdownSourceNode":null,"contentList":[{"title":"The basics","shouldHideFromSidebar":false},{"title":"Generate a new export","shouldHideFromSidebar":false},{"title":"API parameters","shouldHideFromSidebar":false},{"title":"Downloading the data","shouldHideFromSidebar":false},{"title":"Limits on exports","shouldHideFromSidebar":false}]},{"slug":"integrations","headline":"Integrations","contentSource":"Contentful","markdownSourceNode":null,"contentList":[{"title":"The basics","shouldHideFromSidebar":false},{"title":"Building integrations","shouldHideFromSidebar":false},{"title":"Integration Partner Program","shouldHideFromSidebar":false}]},{"slug":"mobile-sdk","headline":"Mobile SDK","contentSource":"Contentful","markdownSourceNode":null,"contentList":[{"title":"The basics","shouldHideFromSidebar":false},{"title":"Installing for iOS","shouldHideFromSidebar":false},{"title":"Installing for Android","shouldHideFromSidebar":false},{"title":"Initializing the Mobile SDK","shouldHideFromSidebar":false},{"title":"Work with contacts","shouldHideFromSidebar":false},{"title":"Work with events","shouldHideFromSidebar":false},{"title":"Android-only features","shouldHideFromSidebar":false},{"title":"iOS-only features","shouldHideFromSidebar":false}]},{"slug":"errors","headline":"Errors","contentSource":"Contentful","markdownSourceNode":null,"contentList":[{"title":"The basics","shouldHideFromSidebar":false},{"title":"Error format","shouldHideFromSidebar":false},{"title":"Common causes","shouldHideFromSidebar":false},{"title":"Error glossary","shouldHideFromSidebar":false}]}]},"refNavData":{"nodes":[{"sectionTitle":"API Root","sectionAnchor":"root","sectionRoute":"/root","paths":[{"operationId":"getRoot","pathRoute":"/root/list-api-root-resources","summary":"List api root resources"}],"subSections":[]},{"sectionTitle":"Account Exports","sectionAnchor":"account-exports","sectionRoute":"/account-exports","paths":[{"operationId":"getAccountExports","pathRoute":"/account-exports/list-account-exports","summary":"List account exports"},{"operationId":"postAccountExport","pathRoute":"/account-exports/add-export","summary":"Add export"},{"operationId":"getAccountExportId","pathRoute":"/account-exports/get-account-export-info","summary":"Get account export info"}],"subSections":[]},{"sectionTitle":"Authorized Apps","sectionAnchor":"authorized-apps","sectionRoute":"/authorized-apps","paths":[{"operationId":"getAuthorizedApps","pathRoute":"/authorized-apps/list-authorized-apps","summary":"List authorized apps"},{"operationId":"getAuthorizedAppsId","pathRoute":"/authorized-apps/get-authorized-app-info","summary":"Get authorized app info"}],"subSections":[]},{"sectionTitle":"Automation flows (Previously Customer Journeys)","sectionAnchor":"customer-journeys-journeys-steps-actions","sectionRoute":"/customer-journeys-journeys-steps-actions","paths":[{"operationId":"postCustomerJourneysJourneysIdStepsIdActionsTrigger","pathRoute":"/customer-journeys-journeys-steps-actions/customer-journeys-api-trigger-for-a-contact","summary":"Customer Journeys API trigger for a contact"}],"subSections":[]},{"sectionTitle":"Automations","sectionAnchor":"automation","sectionRoute":"/automation","paths":[{"operationId":"getAutomations","pathRoute":"/automation/list-automations","summary":"List automations"},{"operationId":"postAutomations","pathRoute":"/automation/add-automation","summary":"Add automation"},{"operationId":"getAutomationsId","pathRoute":"/automation/get-automation-info","summary":"Get automation info"},{"operationId":"postAutomationsIdActionsStartAllEmails","pathRoute":"/automation/start-automation-emails","summary":"Start automation emails"},{"operationId":"postAutomationsIdActionsPauseAllEmails","pathRoute":"/automation/pause-automation-emails","summary":"Pause automation emails"},{"operationId":"archiveAutomations","pathRoute":"/automation/archive-automation","summary":"Archive automation"}],"subSections":[{"sectionTitle":"Emails","sectionAnchor":"automation-email","sectionRoute":"/automation-email","paths":[{"operationId":"getAutomationsIdEmails","pathRoute":"/automation-email/list-automated-emails","summary":"List automated emails"},{"operationId":"getAutomationsIdEmailsId","pathRoute":"/automation-email/get-workflow-email-info","summary":"Get workflow email info"},{"operationId":"deleteAutomationsIdEmailsId","pathRoute":"/automation-email/delete-workflow-email","summary":"Delete workflow email"},{"operationId":"patchAutomationEmailWorkflowId","pathRoute":"/automation-email/update-workflow-email","summary":"Update workflow email"},{"operationId":"postAutomationsIdEmailsIdActionsPause","pathRoute":"/automation-email/pause-automated-email","summary":"Pause automated email"},{"operationId":"postAutomationsIdEmailsIdActionsStart","pathRoute":"/automation-email/start-automated-email","summary":"Start automated email"}],"sectionParent":{"sectionAnchor":"automation"}},{"sectionTitle":"Queue","sectionAnchor":"automation-email-queue","sectionRoute":"/automation-email-queue","paths":[{"operationId":"getAutomationsIdEmailsIdQueue","pathRoute":"/automation-email-queue/list-automated-email-subscribers","summary":"List automated email subscribers"},{"operationId":"postAutomationsIdEmailsIdQueue","pathRoute":"/automation-email-queue/add-subscriber-to-workflow-email","summary":"Add subscriber to workflow email"},{"operationId":"getAutomationsIdEmailsIdQueueId","pathRoute":"/automation-email-queue/get-automated-email-subscriber","summary":"Get automated email subscriber"}],"sectionParent":{"sectionAnchor":"automation"}},{"sectionTitle":"Removed Subscribers","sectionAnchor":"automation-removed-subscribers","sectionRoute":"/automation-removed-subscribers","paths":[{"operationId":"getAutomationsIdRemovedSubscribers","pathRoute":"/automation-removed-subscribers/list-subscribers-removed-from-workflow","summary":"List subscribers removed from workflow"},{"operationId":"postAutomationsIdRemovedSubscribers","pathRoute":"/automation-removed-subscribers/remove-subscriber-from-workflow","summary":"Remove subscriber from workflow"},{"operationId":"getAutomationsIdRemovedSubscribersId","pathRoute":"/automation-removed-subscribers/get-subscriber-removed-from-workflow","summary":"Get subscriber removed from workflow"}],"sectionParent":{"sectionAnchor":"automation"}}]},{"sectionTitle":"Batch Operations","sectionAnchor":"batch-operations","sectionRoute":"/batch-operations","paths":[{"operationId":"getBatches","pathRoute":"/batch-operations/list-batch-requests","summary":"List batch requests"},{"operationId":"postBatches","pathRoute":"/batch-operations/start-batch-operation","summary":"Start batch operation"},{"operationId":"getBatchesId","pathRoute":"/batch-operations/get-batch-operation-status","summary":"Get batch operation status"},{"operationId":"deleteBatchesId","pathRoute":"/batch-operations/delete-batch-request","summary":"Delete batch request"}],"subSections":[]},{"sectionTitle":"Batch Webhooks","sectionAnchor":"batch-webhooks","sectionRoute":"/batch-webhooks","paths":[{"operationId":"getBatchWebhooks","pathRoute":"/batch-webhooks/list-batch-webhooks","summary":"List batch webhooks"},{"operationId":"postBatchWebhooks","pathRoute":"/batch-webhooks/add-batch-webhook","summary":"Add batch webhook"},{"operationId":"getBatchWebhook","pathRoute":"/batch-webhooks/get-batch-webhook-info","summary":"Get batch webhook info"},{"operationId":"patchBatchWebhooks","pathRoute":"/batch-webhooks/update-batch-webhook","summary":"Update batch webhook"},{"operationId":"deleteBatchWebhookId","pathRoute":"/batch-webhooks/delete-batch-webhook","summary":"Delete batch webhook"}],"subSections":[]},{"sectionTitle":"Campaign Folders","sectionAnchor":"campaign-folders","sectionRoute":"/campaign-folders","paths":[{"operationId":"getCampaignFolders","pathRoute":"/campaign-folders/list-campaign-folders","summary":"List campaign folders"},{"operationId":"postCampaignFolders","pathRoute":"/campaign-folders/add-campaign-folder","summary":"Add campaign folder"},{"operationId":"getCampaignFoldersId","pathRoute":"/campaign-folders/get-campaign-folder","summary":"Get campaign folder"},{"operationId":"patchCampaignFoldersId","pathRoute":"/campaign-folders/update-campaign-folder","summary":"Update campaign folder"},{"operationId":"deleteCampaignFoldersId","pathRoute":"/campaign-folders/delete-campaign-folder","summary":"Delete campaign folder"}],"subSections":[]},{"sectionTitle":"Campaigns","sectionAnchor":"campaigns","sectionRoute":"/campaigns","paths":[{"operationId":"getCampaigns","pathRoute":"/campaigns/list-campaigns","summary":"List campaigns"},{"operationId":"postCampaigns","pathRoute":"/campaigns/add-campaign","summary":"Add campaign"},{"operationId":"getCampaignsId","pathRoute":"/campaigns/get-campaign-info","summary":"Get campaign info"},{"operationId":"patchCampaignsId","pathRoute":"/campaigns/update-campaign-settings","summary":"Update campaign settings"},{"operationId":"deleteCampaignsId","pathRoute":"/campaigns/delete-campaign","summary":"Delete campaign"},{"operationId":"postCampaignsIdActionsCancelSend","pathRoute":"/campaigns/cancel-campaign","summary":"Cancel campaign"},{"operationId":"postCampaignsIdActionsSend","pathRoute":"/campaigns/send-campaign","summary":"Send campaign"},{"operationId":"postCampaignsIdActionsSchedule","pathRoute":"/campaigns/schedule-campaign","summary":"Schedule campaign"},{"operationId":"postCampaignsIdActionsUnschedule","pathRoute":"/campaigns/unschedule-campaign","summary":"Unschedule campaign"},{"operationId":"postCampaignsIdActionsPause","pathRoute":"/campaigns/pause-rss-campaign","summary":"Pause rss campaign"},{"operationId":"postCampaignsIdActionsResume","pathRoute":"/campaigns/resume-rss-campaign","summary":"Resume rss campaign"},{"operationId":"postCampaignsIdActionsReplicate","pathRoute":"/campaigns/replicate-campaign","summary":"Replicate campaign"},{"operationId":"postCampaignsIdActionsTest","pathRoute":"/campaigns/send-test-email","summary":"Send test email"},{"operationId":"postCampaignsIdActionsCreateResend","pathRoute":"/campaigns/resend-campaign","summary":"Resend campaign"}],"subSections":[{"sectionTitle":"Content","sectionAnchor":"campaign-content","sectionRoute":"/campaign-content","paths":[{"operationId":"getCampaignsIdContent","pathRoute":"/campaign-content/get-campaign-content","summary":"Get campaign content"},{"operationId":"putCampaignsIdContent","pathRoute":"/campaign-content/set-campaign-content","summary":"Set campaign content"}],"sectionParent":{"sectionAnchor":"campaigns"}},{"sectionTitle":"Feedback","sectionAnchor":"campaign-feedback","sectionRoute":"/campaign-feedback","paths":[{"operationId":"getCampaignsIdFeedback","pathRoute":"/campaign-feedback/list-campaign-feedback","summary":"List campaign feedback"},{"operationId":"postCampaignsIdFeedback","pathRoute":"/campaign-feedback/add-campaign-feedback","summary":"Add campaign feedback"},{"operationId":"getCampaignsIdFeedbackId","pathRoute":"/campaign-feedback/get-campaign-feedback-message","summary":"Get campaign feedback message"},{"operationId":"patchCampaignsIdFeedbackId","pathRoute":"/campaign-feedback/update-campaign-feedback-message","summary":"Update campaign feedback message"},{"operationId":"deleteCampaignsIdFeedbackId","pathRoute":"/campaign-feedback/delete-campaign-feedback-message","summary":"Delete campaign feedback message"}],"sectionParent":{"sectionAnchor":"campaigns"}},{"sectionTitle":"Send Checklist","sectionAnchor":"campaign-checklist","sectionRoute":"/campaign-checklist","paths":[{"operationId":"getCampaignsIdSendChecklist","pathRoute":"/campaign-checklist/get-campaign-send-checklist","summary":"Get campaign send checklist"}],"sectionParent":{"sectionAnchor":"campaigns"}}]},{"sectionTitle":"Chimp Chatter Activity","sectionAnchor":"chimp-chatter","sectionRoute":"/chimp-chatter","paths":[{"operationId":"getActivityFeedChimpChatter","pathRoute":"/chimp-chatter/get-latest-chimp-chatter","summary":"Get latest chimp chatter"}],"subSections":[]},{"sectionTitle":"Connected Sites","sectionAnchor":"connected-sites","sectionRoute":"/connected-sites","paths":[{"operationId":"getConnectedSites","pathRoute":"/connected-sites/list-connected-sites","summary":"List connected sites"},{"operationId":"postConnectedSites","pathRoute":"/connected-sites/add-connected-site","summary":"Add connected site"},{"operationId":"getConnectedSitesId","pathRoute":"/connected-sites/get-connected-site","summary":"Get connected site"},{"operationId":"deleteConnectedSitesId","pathRoute":"/connected-sites/delete-connected-site","summary":"Delete connected site"},{"operationId":"postConnectedSitesIdActionsVerifyScriptInstallation","pathRoute":"/connected-sites/verify-connected-site-script","summary":"Verify connected site script"}],"subSections":[]},{"sectionTitle":"Conversations","sectionAnchor":"conversations","sectionRoute":"/conversations","paths":[{"operationId":"getConversations","pathRoute":"/conversations/list-conversations","summary":"List conversations"},{"operationId":"getConversationsId","pathRoute":"/conversations/get-conversation","summary":"Get conversation"}],"subSections":[{"sectionTitle":"Messages","sectionAnchor":"conversation-messages","sectionRoute":"/conversation-messages","paths":[{"operationId":"getConversationsIdMessages","pathRoute":"/conversation-messages/list-messages","summary":"List messages"},{"operationId":"getConversationsIdMessagesId","pathRoute":"/conversation-messages/get-message","summary":"Get message"}],"sectionParent":{"sectionAnchor":"conversations"}}]},{"sectionTitle":"E-commerce Stores","sectionAnchor":"ecommerce-stores","sectionRoute":"/ecommerce-stores","paths":[{"operationId":"getEcommerceStores","pathRoute":"/ecommerce-stores/list-stores","summary":"List stores"},{"operationId":"postEcommerceStores","pathRoute":"/ecommerce-stores/add-store","summary":"Add store"},{"operationId":"getEcommerceStoresId","pathRoute":"/ecommerce-stores/get-store-info","summary":"Get store info"},{"operationId":"patchEcommerceStoresId","pathRoute":"/ecommerce-stores/update-store","summary":"Update store"},{"operationId":"deleteEcommerceStoresId","pathRoute":"/ecommerce-stores/delete-store","summary":"Delete store"}],"subSections":[{"sectionTitle":"Cart Lines","sectionAnchor":"ecommerce-cart-lines","sectionRoute":"/ecommerce-cart-lines","paths":[{"operationId":"getEcommerceStoresIdCartsIdLines","pathRoute":"/ecommerce-cart-lines/list-cart-line-items","summary":"List cart line items"},{"operationId":"postEcommerceStoresIdCartsIdLines","pathRoute":"/ecommerce-cart-lines/add-cart-line-item","summary":"Add cart line item"},{"operationId":"getEcommerceStoresIdCartsIdLinesId","pathRoute":"/ecommerce-cart-lines/get-cart-line-item","summary":"Get cart line item"},{"operationId":"patchEcommerceStoresIdCartsIdLinesId","pathRoute":"/ecommerce-cart-lines/update-cart-line-item","summary":"Update cart line item"},{"operationId":"deleteEcommerceStoresIdCartsLinesId","pathRoute":"/ecommerce-cart-lines/delete-cart-line-item","summary":"Delete cart line item"}],"sectionParent":{"sectionAnchor":"ecommerce-stores"}},{"sectionTitle":"Carts","sectionAnchor":"ecommerce-carts","sectionRoute":"/ecommerce-carts","paths":[{"operationId":"getEcommerceStoresIdCarts","pathRoute":"/ecommerce-carts/list-carts","summary":"List carts"},{"operationId":"postEcommerceStoresIdCarts","pathRoute":"/ecommerce-carts/add-cart","summary":"Add cart"},{"operationId":"getEcommerceStoresIdCartsId","pathRoute":"/ecommerce-carts/get-cart-info","summary":"Get cart info"},{"operationId":"patchEcommerceStoresIdCartsId","pathRoute":"/ecommerce-carts/update-cart","summary":"Update cart"},{"operationId":"deleteEcommerceStoresIdCartsId","pathRoute":"/ecommerce-carts/delete-cart","summary":"Delete cart"}],"sectionParent":{"sectionAnchor":"ecommerce-stores"}},{"sectionTitle":"Customers","sectionAnchor":"ecommerce-customers","sectionRoute":"/ecommerce-customers","paths":[{"operationId":"getEcommerceStoresIdCustomers","pathRoute":"/ecommerce-customers/list-customers","summary":"List customers"},{"operationId":"postEcommerceStoresIdCustomers","pathRoute":"/ecommerce-customers/add-customer","summary":"Add customer"},{"operationId":"getEcommerceStoresIdCustomersId","pathRoute":"/ecommerce-customers/get-customer-info","summary":"Get customer info"},{"operationId":"putEcommerceStoresIdCustomersId","pathRoute":"/ecommerce-customers/add-or-update-customer","summary":"Add or update customer"},{"operationId":"patchEcommerceStoresIdCustomersId","pathRoute":"/ecommerce-customers/update-customer","summary":"Update customer"},{"operationId":"deleteEcommerceStoresIdCustomersId","pathRoute":"/ecommerce-customers/delete-customer","summary":"Delete customer"}],"sectionParent":{"sectionAnchor":"ecommerce-stores"}},{"sectionTitle":"Order Lines","sectionAnchor":"ecommerce-order-lines","sectionRoute":"/ecommerce-order-lines","paths":[{"operationId":"getEcommerceStoresIdOrdersIdLines","pathRoute":"/ecommerce-order-lines/list-order-line-items","summary":"List order line items"},{"operationId":"postEcommerceStoresIdOrdersIdLines","pathRoute":"/ecommerce-order-lines/add-order-line-item","summary":"Add order line item"},{"operationId":"getEcommerceStoresIdOrdersIdLinesId","pathRoute":"/ecommerce-order-lines/get-order-line-item","summary":"Get order line item"},{"operationId":"patchEcommerceStoresIdOrdersIdLinesId","pathRoute":"/ecommerce-order-lines/update-order-line-item","summary":"Update order line item"},{"operationId":"deleteEcommerceStoresIdOrdersIdLinesId","pathRoute":"/ecommerce-order-lines/delete-order-line-item","summary":"Delete order line item"}],"sectionParent":{"sectionAnchor":"ecommerce-stores"}},{"sectionTitle":"Orders","sectionAnchor":"ecommerce-orders","sectionRoute":"/ecommerce-orders","paths":[{"operationId":"getEcommerceOrders","pathRoute":"/ecommerce-orders/list-account-orders","summary":"List account orders"},{"operationId":"getEcommerceStoresIdOrders","pathRoute":"/ecommerce-orders/list-orders","summary":"List orders"},{"operationId":"postEcommerceStoresIdOrders","pathRoute":"/ecommerce-orders/add-order","summary":"Add order"},{"operationId":"getEcommerceStoresIdOrdersId","pathRoute":"/ecommerce-orders/get-order-info","summary":"Get order info"},{"operationId":"putEcommerceStoresIdOrdersId","pathRoute":"/ecommerce-orders/add-or-update-order","summary":"Add or update order"},{"operationId":"patchEcommerceStoresIdOrdersId","pathRoute":"/ecommerce-orders/update-order","summary":"Update order"},{"operationId":"deleteEcommerceStoresIdOrdersId","pathRoute":"/ecommerce-orders/delete-order","summary":"Delete order"}],"sectionParent":{"sectionAnchor":"ecommerce-stores"}},{"sectionTitle":"Product Images","sectionAnchor":"ecommerce-product-images","sectionRoute":"/ecommerce-product-images","paths":[{"operationId":"getEcommerceStoresIdProductsIdImages","pathRoute":"/ecommerce-product-images/list-product-images","summary":"List product images"},{"operationId":"postEcommerceStoresIdProductsIdImages","pathRoute":"/ecommerce-product-images/add-product-image","summary":"Add product image"},{"operationId":"getEcommerceStoresIdProductsIdImagesId","pathRoute":"/ecommerce-product-images/get-product-image-info","summary":"Get product image info"},{"operationId":"patchEcommerceStoresIdProductsIdImagesId","pathRoute":"/ecommerce-product-images/update-product-image","summary":"Update product image"},{"operationId":"deleteEcommerceStoresIdProductsIdImagesId","pathRoute":"/ecommerce-product-images/delete-product-image","summary":"Delete product image"}],"sectionParent":{"sectionAnchor":"ecommerce-stores"}},{"sectionTitle":"Product Variants","sectionAnchor":"ecommerce-product-variants","sectionRoute":"/ecommerce-product-variants","paths":[{"operationId":"getEcommerceStoresIdProductsIdVariants","pathRoute":"/ecommerce-product-variants/list-product-variants","summary":"List product variants"},{"operationId":"postEcommerceStoresIdProductsIdVariants","pathRoute":"/ecommerce-product-variants/add-product-variant","summary":"Add product variant"},{"operationId":"getEcommerceStoresIdProductsIdVariantsId","pathRoute":"/ecommerce-product-variants/get-product-variant-info","summary":"Get product variant info"},{"operationId":"putEcommerceStoresIdProductsIdVariantsId","pathRoute":"/ecommerce-product-variants/add-or-update-product-variant","summary":"Add or update product variant"},{"operationId":"patchEcommerceStoresIdProductsIdVariantsId","pathRoute":"/ecommerce-product-variants/update-product-variant","summary":"Update product variant"},{"operationId":"deleteEcommerceStoresIdProductsIdVariantsId","pathRoute":"/ecommerce-product-variants/delete-product-variant","summary":"Delete product variant"}],"sectionParent":{"sectionAnchor":"ecommerce-stores"}},{"sectionTitle":"Products","sectionAnchor":"ecommerce-products","sectionRoute":"/ecommerce-products","paths":[{"operationId":"getEcommerceStoresIdProducts","pathRoute":"/ecommerce-products/list-product","summary":"List product"},{"operationId":"postEcommerceStoresIdProducts","pathRoute":"/ecommerce-products/add-product","summary":"Add product"},{"operationId":"getEcommerceStoresIdProductsId","pathRoute":"/ecommerce-products/get-product-info","summary":"Get product info"},{"operationId":"patchEcommerceStoresIdProductsId","pathRoute":"/ecommerce-products/update-product","summary":"Update product"},{"operationId":"putEcommerceStoresIdProductsId","pathRoute":"/ecommerce-products/create-or-update-product","summary":"Create or update product"},{"operationId":"deleteEcommerceStoresIdProductsId","pathRoute":"/ecommerce-products/delete-product","summary":"Delete product"}],"sectionParent":{"sectionAnchor":"ecommerce-stores"}},{"sectionTitle":"Promo Codes","sectionAnchor":"ecommerce-promo-codes","sectionRoute":"/ecommerce-promo-codes","paths":[{"operationId":"getEcommerceStoresIdPromocodes","pathRoute":"/ecommerce-promo-codes/list-promo-codes","summary":"List promo codes"},{"operationId":"postEcommerceStoresIdPromocodes","pathRoute":"/ecommerce-promo-codes/add-promo-code","summary":"Add promo code"},{"operationId":"getEcommerceStoresIdPromocodesId","pathRoute":"/ecommerce-promo-codes/get-promo-code","summary":"Get promo code"},{"operationId":"patchEcommerceStoresIdPromocodesId","pathRoute":"/ecommerce-promo-codes/update-promo-code","summary":"Update promo code"},{"operationId":"deleteEcommerceStoresIdPromocodesId","pathRoute":"/ecommerce-promo-codes/delete-promo-code","summary":"Delete promo code"}],"sectionParent":{"sectionAnchor":"ecommerce-stores"}},{"sectionTitle":"Promo Rules","sectionAnchor":"ecommerce-promo-rules","sectionRoute":"/ecommerce-promo-rules","paths":[{"operationId":"getEcommerceStoresIdPromorules","pathRoute":"/ecommerce-promo-rules/list-promo-rules","summary":"List promo rules"},{"operationId":"postEcommerceStoresIdPromorules","pathRoute":"/ecommerce-promo-rules/add-promo-rule","summary":"Add promo rule"},{"operationId":"getEcommerceStoresIdPromorulesId","pathRoute":"/ecommerce-promo-rules/get-promo-rule","summary":"Get promo rule"},{"operationId":"patchEcommerceStoresIdPromorulesId","pathRoute":"/ecommerce-promo-rules/update-promo-rule","summary":"Update promo rule"},{"operationId":"deleteEcommerceStoresIdPromorulesId","pathRoute":"/ecommerce-promo-rules/delete-promo-rule","summary":"Delete promo rule"}],"sectionParent":{"sectionAnchor":"ecommerce-stores"}}]},{"sectionTitle":"Facebook Ads","sectionAnchor":"facebook-ads","sectionRoute":"/facebook-ads","paths":[{"operationId":"getAllFacebookAds","pathRoute":"/facebook-ads/list-facebook-ads","summary":"List facebook ads"},{"operationId":"getFacebookAdsId","pathRoute":"/facebook-ads/get-facebook-ad-info","summary":"Get facebook ad info"}],"subSections":[]},{"sectionTitle":"File Manager","sectionAnchor":"file-manager","sectionRoute":"/file-manager","paths":[],"subSections":[{"sectionTitle":"File Manager Files","sectionAnchor":"file-manager-files","sectionRoute":"/file-manager-files","paths":[{"operationId":"getFileManagerFiles","pathRoute":"/file-manager-files/list-stored-files","summary":"List stored files"},{"operationId":"postFileManagerFiles","pathRoute":"/file-manager-files/add-file","summary":"Add file"},{"operationId":"getFileManagerFilesId","pathRoute":"/file-manager-files/get-file","summary":"Get file"},{"operationId":"patchFileManagerFilesId","pathRoute":"/file-manager-files/update-file","summary":"Update file"},{"operationId":"deleteFileManagerFilesId","pathRoute":"/file-manager-files/delete-file","summary":"Delete file"}],"sectionParent":{"sectionAnchor":"file-manager"}},{"sectionTitle":"File Manager Folders","sectionAnchor":"file-manager-folders","sectionRoute":"/file-manager-folders","paths":[{"operationId":"getFileManagerFolders","pathRoute":"/file-manager-folders/list-folders","summary":"List folders"},{"operationId":"postFileManagerFolders","pathRoute":"/file-manager-folders/add-folder","summary":"Add folder"},{"operationId":"getFileManagerFoldersId","pathRoute":"/file-manager-folders/get-folder","summary":"Get folder"},{"operationId":"patchFileManagerFoldersId","pathRoute":"/file-manager-folders/update-folder","summary":"Update folder"},{"operationId":"deleteFileManagerFoldersId","pathRoute":"/file-manager-folders/delete-folder","summary":"Delete folder"}],"sectionParent":{"sectionAnchor":"file-manager"}},{"sectionTitle":"Files in Folder","sectionAnchor":"file-manager-folders-files","sectionRoute":"/file-manager-folders-files","paths":[{"operationId":"getFileManagerFoldersFiles","pathRoute":"/file-manager-folders-files/list-stored-files","summary":"List stored files"}],"sectionParent":{"sectionAnchor":"file-manager"}}]},{"sectionTitle":"Landing Pages","sectionAnchor":"landing-pages","sectionRoute":"/landing-pages","paths":[{"operationId":"getAllLandingPages","pathRoute":"/landing-pages/list-landing-pages","summary":"List landing pages"},{"operationId":"postAllLandingPages","pathRoute":"/landing-pages/add-landing-page","summary":"Add landing page"},{"operationId":"getLandingPageId","pathRoute":"/landing-pages/get-landing-page-info","summary":"Get landing page info"},{"operationId":"patchLandingPageId","pathRoute":"/landing-pages/update-landing-page","summary":"Update landing page"},{"operationId":"deleteLandingPageId","pathRoute":"/landing-pages/delete-landing-page","summary":"Delete landing page"},{"operationId":"postLandingPageIdActionsPublish","pathRoute":"/landing-pages/publish-landing-page","summary":"Publish landing page"},{"operationId":"postLandingPageIdActionsUnpublish","pathRoute":"/landing-pages/unpublish-landing-page","summary":"Unpublish landing page"}],"subSections":[{"sectionTitle":"Content","sectionAnchor":"landing-pages-content","sectionRoute":"/landing-pages-content","paths":[{"operationId":"getLandingPageIdContent","pathRoute":"/landing-pages-content/get-landing-page-content","summary":"Get landing page content"}],"sectionParent":{"sectionAnchor":"landing-pages"}}]},{"sectionTitle":"Lists/Audiences","sectionAnchor":"lists","sectionRoute":"/lists","paths":[{"operationId":"getLists","pathRoute":"/lists/get-lists-info","summary":"Get lists info"},{"operationId":"postLists","pathRoute":"/lists/add-list","summary":"Add list"},{"operationId":"getListsId","pathRoute":"/lists/get-list-info","summary":"Get list info"},{"operationId":"patchListsId","pathRoute":"/lists/update-lists","summary":"Update lists"},{"operationId":"deleteListsId","pathRoute":"/lists/delete-list","summary":"Delete list"},{"operationId":"postListsId","pathRoute":"/lists/batch-subscribe-or-unsubscribe","summary":"Batch subscribe or unsubscribe"}],"subSections":[{"sectionTitle":"Abuse Reports","sectionAnchor":"abuse-reports","sectionRoute":"/abuse-reports","paths":[{"operationId":"getListsIdAbuseReports","pathRoute":"/abuse-reports/list-abuse-reports","summary":"List abuse reports"},{"operationId":"getListsIdAbuseReportsId","pathRoute":"/abuse-reports/get-abuse-report","summary":"Get abuse report"}],"sectionParent":{"sectionAnchor":"lists"}},{"sectionTitle":"Activity","sectionAnchor":"list-activity","sectionRoute":"/list-activity","paths":[{"operationId":"getListsIdActivity","pathRoute":"/list-activity/list-recent-activity","summary":"List recent activity"}],"sectionParent":{"sectionAnchor":"lists"}},{"sectionTitle":"Clients","sectionAnchor":"list-clients","sectionRoute":"/list-clients","paths":[{"operationId":"getListsIdClients","pathRoute":"/list-clients/list-top-email-clients","summary":"List top email clients"}],"sectionParent":{"sectionAnchor":"lists"}},{"sectionTitle":"Events","sectionAnchor":"list-member-events","sectionRoute":"/list-member-events","paths":[{"operationId":"getListsIdMembersIdEvents","pathRoute":"/list-member-events/list-member-events","summary":"List member events"},{"operationId":"postListMemberEvents","pathRoute":"/list-member-events/add-event","summary":"Add event"}],"sectionParent":{"sectionAnchor":"lists"}},{"sectionTitle":"Growth History","sectionAnchor":"list-growth-history","sectionRoute":"/list-growth-history","paths":[{"operationId":"getListsIdGrowthHistory","pathRoute":"/list-growth-history/list-growth-history-data","summary":"List growth history data"},{"operationId":"getListsIdGrowthHistoryId","pathRoute":"/list-growth-history/get-growth-history-by-month","summary":"Get growth history by month"}],"sectionParent":{"sectionAnchor":"lists"}},{"sectionTitle":"Interest Categories","sectionAnchor":"interest-categories","sectionRoute":"/interest-categories","paths":[{"operationId":"getListsIdInterestCategories","pathRoute":"/interest-categories/list-interest-categories","summary":"List interest categories"},{"operationId":"postListsIdInterestCategories","pathRoute":"/interest-categories/add-interest-category","summary":"Add interest category"},{"operationId":"getListsIdInterestCategoriesId","pathRoute":"/interest-categories/get-interest-category-info","summary":"Get interest category info"},{"operationId":"patchListsIdInterestCategoriesId","pathRoute":"/interest-categories/update-interest-category","summary":"Update interest category"},{"operationId":"deleteListsIdInterestCategoriesId","pathRoute":"/interest-categories/delete-interest-category","summary":"Delete interest category"}],"sectionParent":{"sectionAnchor":"lists"}},{"sectionTitle":"Interests","sectionAnchor":"interests","sectionRoute":"/interests","paths":[{"operationId":"getListsIdInterestCategoriesIdInterests","pathRoute":"/interests/list-interests-in-category","summary":"List interests in category"},{"operationId":"postListsIdInterestCategoriesIdInterests","pathRoute":"/interests/add-interest-in-category","summary":"Add interest in category"},{"operationId":"getListsIdInterestCategoriesIdInterestsId","pathRoute":"/interests/get-interest-in-category","summary":"Get interest in category"},{"operationId":"patchListsIdInterestCategoriesIdInterestsId","pathRoute":"/interests/update-interest-in-category","summary":"Update interest in category"},{"operationId":"deleteListsIdInterestCategoriesIdInterestsId","pathRoute":"/interests/delete-interest-in-category","summary":"Delete interest in category"}],"sectionParent":{"sectionAnchor":"lists"}},{"sectionTitle":"Locations","sectionAnchor":"list-locations","sectionRoute":"/list-locations","paths":[{"operationId":"getListsIdLocations","pathRoute":"/list-locations/list-locations","summary":"List locations"}],"sectionParent":{"sectionAnchor":"lists"}},{"sectionTitle":"Member Activity","sectionAnchor":"list-member-activity","sectionRoute":"/list-member-activity","paths":[{"operationId":"getListsIdMembersIdActivity","pathRoute":"/list-member-activity/view-recent-activity-50","summary":"View recent activity 50"}],"sectionParent":{"sectionAnchor":"lists"}},{"sectionTitle":"Member Activity Feed","sectionAnchor":"list-member-activity-feed","sectionRoute":"/list-member-activity-feed","paths":[{"operationId":"getListsIdMembersIdActivityFeed","pathRoute":"/list-member-activity-feed/view-recent-activity","summary":"View recent activity"}],"sectionParent":{"sectionAnchor":"lists"}},{"sectionTitle":"Member Goals","sectionAnchor":"list-member-goal","sectionRoute":"/list-member-goal","paths":[{"operationId":"getListsIdMembersIdGoals","pathRoute":"/list-member-goal/list-member-goal-events","summary":"List member goal events"}],"sectionParent":{"sectionAnchor":"lists"}},{"sectionTitle":"Member Notes","sectionAnchor":"list-member-notes","sectionRoute":"/list-member-notes","paths":[{"operationId":"getListsIdMembersIdNotes","pathRoute":"/list-member-notes/list-recent-member-notes","summary":"List recent member notes"},{"operationId":"postListsIdMembersIdNotes","pathRoute":"/list-member-notes/add-member-note","summary":"Add member note"},{"operationId":"getListsIdMembersIdNotesId","pathRoute":"/list-member-notes/get-member-note","summary":"Get member note"},{"operationId":"patchListsIdMembersIdNotesId","pathRoute":"/list-member-notes/update-note","summary":"Update note"},{"operationId":"deleteListsIdMembersIdNotesId","pathRoute":"/list-member-notes/delete-note","summary":"Delete note"}],"sectionParent":{"sectionAnchor":"lists"}},{"sectionTitle":"Member Tags","sectionAnchor":"list-member-tags","sectionRoute":"/list-member-tags","paths":[{"operationId":"getListMemberTags","pathRoute":"/list-member-tags/list-member-tags","summary":"List member tags"},{"operationId":"postListMemberTags","pathRoute":"/list-member-tags/add-or-remove-member-tags","summary":"Add or remove member tags"}],"sectionParent":{"sectionAnchor":"lists"}},{"sectionTitle":"Members","sectionAnchor":"list-members","sectionRoute":"/list-members","paths":[{"operationId":"getListsIdMembers","pathRoute":"/list-members/list-members-info","summary":"List members info"},{"operationId":"postListsIdMembers","pathRoute":"/list-members/add-member-to-list","summary":"Add member to list"},{"operationId":"getListsIdMembersId","pathRoute":"/list-members/get-member-info","summary":"Get member info"},{"operationId":"putListsIdMembersId","pathRoute":"/list-members/add-or-update-list-member","summary":"Add or update list member"},{"operationId":"patchListsIdMembersId","pathRoute":"/list-members/update-list-member","summary":"Update list member"},{"operationId":"deleteListsIdMembersId","pathRoute":"/list-members/archive-list-member","summary":"Archive list member"},{"operationId":"postListsIdMembersHashActionsDeletePermanent","pathRoute":"/list-members/delete-list-member","summary":"Delete list member"}],"sectionParent":{"sectionAnchor":"lists"}},{"sectionTitle":"Merge Fields","sectionAnchor":"list-merges","sectionRoute":"/list-merges","paths":[{"operationId":"getListsIdMergeFields","pathRoute":"/list-merges/list-merge-fields","summary":"List merge fields"},{"operationId":"postListsIdMergeFields","pathRoute":"/list-merges/add-merge-field","summary":"Add merge field"},{"operationId":"getListsIdMergeFieldsId","pathRoute":"/list-merges/get-merge-field","summary":"Get merge field"},{"operationId":"patchListsIdMergeFieldsId","pathRoute":"/list-merges/update-merge-field","summary":"Update merge field"},{"operationId":"deleteListsIdMergeFieldsId","pathRoute":"/list-merges/delete-merge-field","summary":"Delete merge field"}],"sectionParent":{"sectionAnchor":"lists"}},{"sectionTitle":"Segment Members","sectionAnchor":"list-segment-members","sectionRoute":"/list-segment-members","paths":[{"operationId":"getListsIdSegmentsIdMembers","pathRoute":"/list-segment-members/list-members-in-segment","summary":"List members in segment"},{"operationId":"postListsIdSegmentsIdMembers","pathRoute":"/list-segment-members/add-member-to-segment","summary":"Add member to segment"},{"operationId":"deleteListsIdSegmentsIdMembersId","pathRoute":"/list-segment-members/remove-list-member-from-segment","summary":"Remove list member from segment"}],"sectionParent":{"sectionAnchor":"lists"}},{"sectionTitle":"Segments","sectionAnchor":"list-segments","sectionRoute":"/list-segments","paths":[{"operationId":"previewASegment","pathRoute":"/list-segments/list-segments","summary":"List segments"},{"operationId":"postListsIdSegments","pathRoute":"/list-segments/add-segment","summary":"Add segment"},{"operationId":"getListsIdSegmentsId","pathRoute":"/list-segments/get-segment-info","summary":"Get segment info"},{"operationId":"deleteListsIdSegmentsId","pathRoute":"/list-segments/delete-segment","summary":"Delete segment"},{"operationId":"patchListsIdSegmentsId","pathRoute":"/list-segments/update-segment","summary":"Update segment"},{"operationId":"postListsIdSegmentsId","pathRoute":"/list-segments/batch-add-or-remove-members","summary":"Batch add or remove members"}],"sectionParent":{"sectionAnchor":"lists"}},{"sectionTitle":"Signup Forms","sectionAnchor":"list-signup-forms","sectionRoute":"/list-signup-forms","paths":[{"operationId":"getListsIdSignupForms","pathRoute":"/list-signup-forms/list-signup-forms","summary":"List signup forms"},{"operationId":"postListsIdSignupForms","pathRoute":"/list-signup-forms/customize-signup-form","summary":"Customize signup form"}],"sectionParent":{"sectionAnchor":"lists"}},{"sectionTitle":"Surveys","sectionAnchor":"list-surveys","sectionRoute":"/list-surveys","paths":[{"operationId":"getListsIdSurveys","pathRoute":"/list-surveys/get-information-about-all-surveys-for-a-list","summary":"Get information about all surveys for a list"},{"operationId":"getListsIdSurveysId","pathRoute":"/list-surveys/get-survey","summary":"Get survey"},{"operationId":"postListsIdSurveysIdActionsPublish","pathRoute":"/list-surveys/publish-a-survey","summary":"Publish a Survey"},{"operationId":"postListsIdSurveysIdActionsUnpublish","pathRoute":"/list-surveys/unpublish-a-survey","summary":"Unpublish a Survey"},{"operationId":"postListsIdSurveysIdActionsCreateEmail","pathRoute":"/list-surveys/create-a-survey-campaign","summary":"Create a Survey Campaign"}],"sectionParent":{"sectionAnchor":"lists"}},{"sectionTitle":"Tag Search","sectionAnchor":"lists-tags-search","sectionRoute":"/lists-tags-search","paths":[{"operationId":"searchTagsByName","pathRoute":"/lists-tags-search/search-for-tags-on-a-list-by-name","summary":"Search for tags on a list by name."}],"sectionParent":{"sectionAnchor":"lists"}},{"sectionTitle":"Webhooks","sectionAnchor":"list-webhooks","sectionRoute":"/list-webhooks","paths":[{"operationId":"getListsIdWebhooks","pathRoute":"/list-webhooks/list-webhooks","summary":"List webhooks"},{"operationId":"postListsIdWebhooks","pathRoute":"/list-webhooks/add-webhook","summary":"Add webhook"},{"operationId":"getListsIdWebhooksId","pathRoute":"/list-webhooks/get-webhook-info","summary":"Get webhook info"},{"operationId":"deleteListsIdWebhooksId","pathRoute":"/list-webhooks/delete-webhook","summary":"Delete webhook"},{"operationId":"patchListsIdWebhooksId","pathRoute":"/list-webhooks/update-webhook","summary":"Update webhook"}],"sectionParent":{"sectionAnchor":"lists"}}]},{"sectionTitle":"Ping","sectionAnchor":"ping","sectionRoute":"/ping","paths":[{"operationId":"getPing","pathRoute":"/ping/ping","summary":"Ping"}],"subSections":[]},{"sectionTitle":"Reporting","sectionAnchor":"reporting","sectionRoute":"/reporting","paths":[],"subSections":[{"sectionTitle":"Facebook Ads","sectionAnchor":"reporting-facebook-ads","sectionRoute":"/reporting-facebook-ads","paths":[{"operationId":"getReportingFacebookAds","pathRoute":"/reporting-facebook-ads/list-facebook-ads-reports","summary":"List facebook ads reports"},{"operationId":"getReportingFacebookAdsId","pathRoute":"/reporting-facebook-ads/get-facebook-ad-report","summary":"Get facebook ad report"},{"operationId":"getReportingFacebookAdsIdEcommerceProductActivity","pathRoute":"/reporting-facebook-ads/list-facebook-ecommerce-report","summary":"List facebook ecommerce report"}],"sectionParent":{"sectionAnchor":"reporting"}},{"sectionTitle":"Landing Pages","sectionAnchor":"reporting-landing-pages","sectionRoute":"/reporting-landing-pages","paths":[{"operationId":"getReportingLandingPages","pathRoute":"/reporting-landing-pages/list-landing-pages-reports","summary":"List landing pages reports"},{"operationId":"getReportingLandingPagesId","pathRoute":"/reporting-landing-pages/get-landing-page-report","summary":"Get landing page report"}],"sectionParent":{"sectionAnchor":"reporting"}},{"sectionTitle":"Survey Question Answers","sectionAnchor":"reporting-surveys-questions-answers","sectionRoute":"/reporting-surveys-questions-answers","paths":[{"operationId":"getReportingSurveysIdQuestionsIdAnswers","pathRoute":"/reporting-surveys-questions-answers/list-answers-for-question","summary":"List answers for question"}],"sectionParent":{"sectionAnchor":"reporting"}},{"sectionTitle":"Survey Questions","sectionAnchor":"reporting-surveys-questions","sectionRoute":"/reporting-surveys-questions","paths":[{"operationId":"getReportingSurveysIdQuestions","pathRoute":"/reporting-surveys-questions/list-survey-question-reports","summary":"List survey question reports"},{"operationId":"getReportingSurveysIdQuestionsId","pathRoute":"/reporting-surveys-questions/get-survey-question-report","summary":"Get survey question report"}],"sectionParent":{"sectionAnchor":"reporting"}},{"sectionTitle":"Survey Responses","sectionAnchor":"reporting-surveys-responses","sectionRoute":"/reporting-surveys-responses","paths":[{"operationId":"getReportingSurveysIdResponses","pathRoute":"/reporting-surveys-responses/list-survey-responses","summary":"List survey responses"},{"operationId":"getReportingSurveysIdResponsesId","pathRoute":"/reporting-surveys-responses/get-survey-response","summary":"Get survey response"}],"sectionParent":{"sectionAnchor":"reporting"}},{"sectionTitle":"Surveys","sectionAnchor":"reporting-surveys","sectionRoute":"/reporting-surveys","paths":[{"operationId":"getReportingSurveys","pathRoute":"/reporting-surveys/list-survey-reports","summary":"List survey reports"},{"operationId":"getReportingSurveysId","pathRoute":"/reporting-surveys/get-survey-report","summary":"Get survey report"}],"sectionParent":{"sectionAnchor":"reporting"}}]},{"sectionTitle":"Reports","sectionAnchor":"reports","sectionRoute":"/reports","paths":[{"operationId":"getReports","pathRoute":"/reports/list-campaign-reports","summary":"List campaign reports"},{"operationId":"getReportsId","pathRoute":"/reports/get-campaign-report","summary":"Get campaign report"}],"subSections":[{"sectionTitle":"Campaign Abuse","sectionAnchor":"campaign-abuse","sectionRoute":"/campaign-abuse","paths":[{"operationId":"getReportsIdAbuseReportsId","pathRoute":"/campaign-abuse/list-abuse-reports","summary":"List abuse reports"},{"operationId":"getReportsIdAbuseReportsIdId","pathRoute":"/campaign-abuse/get-abuse-report","summary":"Get abuse report"}],"sectionParent":{"sectionAnchor":"reports"}},{"sectionTitle":"Campaign Advice","sectionAnchor":"campaign-advice","sectionRoute":"/campaign-advice","paths":[{"operationId":"getReportsIdAdvice","pathRoute":"/campaign-advice/list-campaign-feedback","summary":"List campaign feedback"}],"sectionParent":{"sectionAnchor":"reports"}},{"sectionTitle":"Campaign Open Reports","sectionAnchor":"open-reports","sectionRoute":"/open-reports","paths":[{"operationId":"getReportsIdOpenDetails","pathRoute":"/open-reports/list-campaign-open-details","summary":"List campaign open details"},{"operationId":"getReportsIdOpenDetailsIdMembersId","pathRoute":"/open-reports/get-opened-campaign-subscriber","summary":"Get opened campaign subscriber"}],"sectionParent":{"sectionAnchor":"reports"}},{"sectionTitle":"Click Reports","sectionAnchor":"click-reports","sectionRoute":"/click-reports","paths":[{"operationId":"getReportsIdClickDetails","pathRoute":"/click-reports/list-campaign-details","summary":"List campaign details"},{"operationId":"getReportsIdClickDetailsId","pathRoute":"/click-reports/get-campaign-link-details","summary":"Get campaign link details"}],"sectionParent":{"sectionAnchor":"reports"}},{"sectionTitle":"Click Reports Members","sectionAnchor":"link-clickers","sectionRoute":"/link-clickers","paths":[{"operationId":"getReportsIdClickDetailsIdMembers","pathRoute":"/link-clickers/list-clicked-link-subscribers","summary":"List clicked link subscribers"},{"operationId":"getReportsIdClickDetailsIdMembersId","pathRoute":"/link-clickers/get-clicked-link-subscriber","summary":"Get clicked link subscriber"}],"sectionParent":{"sectionAnchor":"reports"}},{"sectionTitle":"Domain Performance","sectionAnchor":"domain-performance-reports","sectionRoute":"/domain-performance-reports","paths":[{"operationId":"getReportsIdDomainPerformance","pathRoute":"/domain-performance-reports/list-domain-performance-stats","summary":"List domain performance stats"}],"sectionParent":{"sectionAnchor":"reports"}},{"sectionTitle":"Ecommerce Product Activity","sectionAnchor":"campaign-ecommerce-product-activity","sectionRoute":"/campaign-ecommerce-product-activity","paths":[{"operationId":"getReportsIdEcommerceProductActivity","pathRoute":"/campaign-ecommerce-product-activity/list-campaign-product-activity","summary":"List campaign product activity"}],"sectionParent":{"sectionAnchor":"reports"}},{"sectionTitle":"EepURL Reports","sectionAnchor":"eepurl-reports","sectionRoute":"/eepurl-reports","paths":[{"operationId":"getReportsIdEepurl","pathRoute":"/eepurl-reports/list-eep-url-activity","summary":"List EepURL activity"}],"sectionParent":{"sectionAnchor":"reports"}},{"sectionTitle":"Email Activity","sectionAnchor":"email-activity-reports","sectionRoute":"/email-activity-reports","paths":[{"operationId":"getReportsIdEmailActivity","pathRoute":"/email-activity-reports/list-email-activity","summary":"List email activity"},{"operationId":"getReportsIdEmailActivityId","pathRoute":"/email-activity-reports/get-subscriber-email-activity","summary":"Get subscriber email activity"}],"sectionParent":{"sectionAnchor":"reports"}},{"sectionTitle":"Location","sectionAnchor":"location-reports","sectionRoute":"/location-reports","paths":[{"operationId":"getReportsIdLocations","pathRoute":"/location-reports/list-top-open-activities","summary":"List top open activities"}],"sectionParent":{"sectionAnchor":"reports"}},{"sectionTitle":"Sent To","sectionAnchor":"sent-to-reports","sectionRoute":"/sent-to-reports","paths":[{"operationId":"getReportsIdSentTo","pathRoute":"/sent-to-reports/list-campaign-recipients","summary":"List campaign recipients"},{"operationId":"getReportsIdSentToId","pathRoute":"/sent-to-reports/get-campaign-recipient-info","summary":"Get campaign recipient info"}],"sectionParent":{"sectionAnchor":"reports"}},{"sectionTitle":"Sub-Reports","sectionAnchor":"sub-reports","sectionRoute":"/sub-reports","paths":[{"operationId":"getReportsIdSubReportsId","pathRoute":"/sub-reports/list-child-campaign-reports","summary":"List child campaign reports"}],"sectionParent":{"sectionAnchor":"reports"}},{"sectionTitle":"Unsubscribes","sectionAnchor":"unsub-reports","sectionRoute":"/unsub-reports","paths":[{"operationId":"getReportsIdUnsubscribed","pathRoute":"/unsub-reports/list-unsubscribed-members","summary":"List unsubscribed members"},{"operationId":"getReportsIdUnsubscribedId","pathRoute":"/unsub-reports/get-unsubscribed-member","summary":"Get unsubscribed member"}],"sectionParent":{"sectionAnchor":"reports"}}]},{"sectionTitle":"Search Campaigns","sectionAnchor":"search-campaigns","sectionRoute":"/search-campaigns","paths":[{"operationId":"getSearchCampaigns","pathRoute":"/search-campaigns/search-campaigns","summary":"Search campaigns"}],"subSections":[]},{"sectionTitle":"Search Members","sectionAnchor":"search-members","sectionRoute":"/search-members","paths":[{"operationId":"getSearchMembers","pathRoute":"/search-members/search-members","summary":"Search members"}],"subSections":[]},{"sectionTitle":"Template Folders","sectionAnchor":"template-folders","sectionRoute":"/template-folders","paths":[{"operationId":"getTemplateFolders","pathRoute":"/template-folders/list-template-folders","summary":"List template folders"},{"operationId":"postTemplateFolders","pathRoute":"/template-folders/add-template-folder","summary":"Add template folder"},{"operationId":"getTemplateFoldersId","pathRoute":"/template-folders/get-template-folder","summary":"Get template folder"},{"operationId":"patchTemplateFoldersId","pathRoute":"/template-folders/update-template-folder","summary":"Update template folder"},{"operationId":"deleteTemplateFoldersId","pathRoute":"/template-folders/delete-template-folder","summary":"Delete template folder"}],"subSections":[]},{"sectionTitle":"Templates","sectionAnchor":"templates","sectionRoute":"/templates","paths":[{"operationId":"getTemplates","pathRoute":"/templates/list-templates","summary":"List templates"},{"operationId":"postTemplates","pathRoute":"/templates/add-template","summary":"Add template"},{"operationId":"getTemplatesId","pathRoute":"/templates/get-template-info","summary":"Get template info"},{"operationId":"patchTemplatesId","pathRoute":"/templates/update-template","summary":"Update template"},{"operationId":"deleteTemplatesId","pathRoute":"/templates/delete-template","summary":"Delete template"}],"subSections":[{"sectionTitle":"Default Content","sectionAnchor":"template-default-content","sectionRoute":"/template-default-content","paths":[{"operationId":"getTemplatesIdDefaultContent","pathRoute":"/template-default-content/view-default-content","summary":"View default content"}],"sectionParent":{"sectionAnchor":"templates"}}]},{"sectionTitle":"Verified Domains","sectionAnchor":"verified-domains","sectionRoute":"/verified-domains","paths":[{"operationId":"getVerifiedDomains","pathRoute":"/verified-domains/list-sending-domains","summary":"List sending domains"},{"operationId":"createVerifiedDomain","pathRoute":"/verified-domains/add-domain-to-account","summary":"Add domain to account"},{"operationId":"getVerifiedDomain","pathRoute":"/verified-domains/get-domain-info","summary":"Get domain info"},{"operationId":"deleteVerifiedDomain","pathRoute":"/verified-domains/delete-domain","summary":"Delete domain"},{"operationId":"verifyDomain","pathRoute":"/verified-domains/verify-domain","summary":"Verify domain"}],"subSections":[]}]},"refData":{"nodes":[{"sectionTitle":"API Root","sectionAnchor":"root","sectionDescription":"The API root resource links to all other resources available in the API. Calling the root directory also returns details about the Mailchimp user account.","sectionRoute":"/root","paths":[{"operationId":"getRoot","pathRoute":"/root/list-api-root-resources","description":"Get links to all other resources available in the API.","summary":"List api root resources","endpoint":"/","verb":"get","tags":["root"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.root.getRoot();\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->root->getRoot();\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.root.get_root()\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.root.get_root\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]}],"subSections":[]},{"sectionTitle":"Account Exports","sectionAnchor":"account-exports","sectionDescription":"Generate a new account export or download a finished account export.","sectionRoute":"/account-exports","paths":[{"operationId":"getAccountExports","pathRoute":"/account-exports/list-account-exports","description":"Get a list of account exports for a given account.","summary":"List account exports","endpoint":"/account-exports","verb":"get","tags":["accountExports"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.accountExports.listAccountExports();\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->accountExports->listAccountExports();\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.accountExports.list_account_exports()\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.accountExports.list_account_exports\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/account-exports?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>&count=10&offset=0' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"postAccountExport","pathRoute":"/account-exports/add-export","description":"Create a new account export in your Mailchimp account.","summary":"Add export","endpoint":"/account-exports","verb":"post","tags":["accountExports"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.accountExports.createAccountExport({\n    include_stages: '[\"audiences\", \"gallery_files\"]',\n  });\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->accountExports->createAccountExport([\n    \"include_stages\" => \"[\\\"audiences\\\", \\\"gallery_files\\\"]\",\n]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.accountExports.create_account_export({\"include_stages\": \"[\\\"audiences\\\", \\\"gallery_files\\\"]\"})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.accountExports.create_account_export(\n      { 'include_stages' => \"[\\\"audiences\\\", \\\"gallery_files\\\"]\" }\n    )\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n  https://${dc}.api.mailchimp.com/3.0/account-exports \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"include_stages\":[],\"since_timestamp\":\"\"}'"}]},{"operationId":"getAccountExportId","pathRoute":"/account-exports/get-account-export-info","description":"Get information about a specific account export.","summary":"Get account export info","endpoint":"/account-exports/{export_id}","verb":"get","tags":["accountExport"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.accountExport.getAccountExports(\"export_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->accountExport->getAccountExports(\"export_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.accountExport.get_account_exports(\"export_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.accountExport.get_account_exports('export_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/account-exports/{export_id}?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]}],"subSections":[]},{"sectionTitle":"Authorized Apps","sectionAnchor":"authorized-apps","sectionDescription":"Manage registered, connected apps for your Mailchimp account with the Authorized Apps endpoints.","sectionRoute":"/authorized-apps","paths":[{"operationId":"getAuthorizedApps","pathRoute":"/authorized-apps/list-authorized-apps","description":"Get a list of an account's registered, connected applications.","summary":"List authorized apps","endpoint":"/authorized-apps","verb":"get","tags":["authorizedApps"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.authorizedApps.list();\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->authorizedApps->list();\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.authorizedApps.list()\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.authorizedApps.list\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/authorized-apps?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>&count=10&offset=0' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"getAuthorizedAppsId","pathRoute":"/authorized-apps/get-authorized-app-info","description":"Get information about a specific authorized application.","summary":"Get authorized app info","endpoint":"/authorized-apps/{app_id}","verb":"get","tags":["authorizedApps"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.authorizedApps.get(\"app_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->authorizedApps->get(\"app_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.authorizedApps.get(\"app_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.authorizedApps.get('app_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/authorized-apps/{app_id}?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]}],"subSections":[]},{"sectionTitle":"Automation flows (Previously Customer Journeys)","sectionAnchor":"customer-journeys-journeys-steps-actions","sectionDescription":"Manage Automation flows","sectionRoute":"/customer-journeys-journeys-steps-actions","paths":[{"operationId":"postCustomerJourneysJourneysIdStepsIdActionsTrigger","pathRoute":"/customer-journeys-journeys-steps-actions/customer-journeys-api-trigger-for-a-contact","description":"A step trigger in an Automation flow. To use it, create a starting point or step from the Automation flow builder in the app using the Customer Journey API condition. We'll provide a url during the process that includes the {journey_id} and {step_id}. You'll then be able to use this endpoint to trigger the condition for the posted contact.","summary":"Customer Journeys API trigger for a contact","endpoint":"/customer-journeys/journeys/{journey_id}/steps/{step_id}/actions/trigger","verb":"post","tags":["customerJourneys"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.customerJourneys.trigger(32122, 84541, {\n    email_address: \"Joanie_Hickle73@gmail.com\",\n  });\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->customerJourneys->trigger(63200, 5228, [\n    \"email_address\" => \"Stefanie_Hammes@gmail.com\",\n]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.customerJourneys.trigger(91686, 92278, {\"email_address\": \"Annamae_Metz53@hotmail.com\"})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.customerJourneys.trigger(\n      28_182,\n      21_294,\n      { 'email_address' => 'Marc88@gmail.com' }\n    )\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n  https://${dc}.api.mailchimp.com/3.0/customer-journeys/journeys/{journey_id}/steps/{step_id}/actions/trigger \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"email_address\":\"\"}'"}]}],"subSections":[]},{"sectionTitle":"Automations","sectionAnchor":"automation","sectionDescription":"Mailchimp's classic automations feature lets you build a series of emails that send to subscribers when triggered by a specific date, activity, or event. Use the API to manage Automation workflows, emails, and queues. Does not include Automation flows.","sectionRoute":"/automation","paths":[{"operationId":"getAutomations","pathRoute":"/automation/list-automations","description":"Get a summary of an account's classic automations.","summary":"List automations","endpoint":"/automations","verb":"get","tags":["automations"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.automations.list();\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->automations->list();\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.automations.list()\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.automations.list\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/automations?count=10&offset=0&fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>&before_create_time=<SOME_STRING_VALUE>&since_create_time=<SOME_STRING_VALUE>&before_start_time=<SOME_STRING_VALUE>&since_start_time=<SOME_STRING_VALUE>&status=<SOME_STRING_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"postAutomations","pathRoute":"/automation/add-automation","description":"Create a new classic automation in your Mailchimp account.","summary":"Add automation","endpoint":"/automations","verb":"post","tags":["automations"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.automations.create({\n    recipients: {},\n    trigger_settings: { workflow_type: \"workflow_type\" },\n  });\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->automations->create([\n    \"recipients\" => [],\n    \"trigger_settings\" => [\"workflow_type\" => \"workflow_type\"],\n]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.automations.create({\"recipients\": {}, \"trigger_settings\": {\"workflow_type\": \"workflow_type\"}})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.automations.create(\n      {\n        'recipients' => {},\n        'trigger_settings' => { 'workflow_type' => 'workflow_type' }\n      }\n    )\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n  https://${dc}.api.mailchimp.com/3.0/automations \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"recipients\":{\"list_id\":\"\",\"store_id\":\"\"},\"settings\":{\"from_name\":\"\",\"reply_to\":\"\"},\"trigger_settings\":{\"workflow_type\":\"\"}}'"}]},{"operationId":"getAutomationsId","pathRoute":"/automation/get-automation-info","description":"Get a summary of an individual classic automation workflow's settings and content. The `trigger_settings` object returns information for the first email in the workflow.","summary":"Get automation info","endpoint":"/automations/{workflow_id}","verb":"get","tags":["automations"],"deprecated":null,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.automations.get(\"workflow_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->automations->get(\"workflow_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.automations.get(\"workflow_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.automations.get('workflow_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/automations/{workflow_id}?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"postAutomationsIdActionsStartAllEmails","pathRoute":"/automation/start-automation-emails","description":"Start all emails in a classic automation workflow.","summary":"Start automation emails","endpoint":"/automations/{workflow_id}/actions/start-all-emails","verb":"post","tags":["automations"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.automations.startAllEmails(\"workflow_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->automations->startAllEmails(\"workflow_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.automations.start_all_emails(\"workflow_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.automations.start_all_emails('workflow_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n  https://${dc}.api.mailchimp.com/3.0/automations/{workflow_id}/actions/start-all-emails \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"postAutomationsIdActionsPauseAllEmails","pathRoute":"/automation/pause-automation-emails","description":"Pause all emails in a specific classic automation workflow.","summary":"Pause automation emails","endpoint":"/automations/{workflow_id}/actions/pause-all-emails","verb":"post","tags":["automations"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.automations.pauseAllEmails(\"workflow_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->automations->pauseAllEmails(\"workflow_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.automations.pause_all_emails(\"workflow_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.automations.pause_all_emails('workflow_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n  https://${dc}.api.mailchimp.com/3.0/automations/{workflow_id}/actions/pause-all-emails \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"archiveAutomations","pathRoute":"/automation/archive-automation","description":"Archiving will permanently end your automation and keep the report data. You’ll be able to replicate your archived automation, but you can’t restart it.","summary":"Archive automation","endpoint":"/automations/{workflow_id}/actions/archive","verb":"post","tags":["automations"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.automations.archive(\"workflow_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->automations->archive(\"workflow_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.automations.archive(\"workflow_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.automations.archive('workflow_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n  https://${dc}.api.mailchimp.com/3.0/automations/{workflow_id}/actions/archive \\\n  --user \"anystring:${apikey}\"'"}]}],"subSections":[{"sectionTitle":"Emails","sectionAnchor":"automation-email","sectionDescription":"Manage individual emails in a classic automation workflow.","sectionRoute":"/automation-email","paths":[{"operationId":"getAutomationsIdEmails","pathRoute":"/automation-email/list-automated-emails","description":"Get a summary of the emails in a classic automation workflow.","summary":"List automated emails","endpoint":"/automations/{workflow_id}/emails","verb":"get","tags":["automations"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.automations.listAllWorkflowEmails(\n    \"workflow_id\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->automations->listAllWorkflowEmails(\"workflow_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.automations.list_all_workflow_emails(\"workflow_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.automations.list_all_workflow_emails('workflow_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  https://${dc}.api.mailchimp.com/3.0/automations/{workflow_id}/emails \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"getAutomationsIdEmailsId","pathRoute":"/automation-email/get-workflow-email-info","description":"Get information about an individual classic automation workflow email.","summary":"Get workflow email info","endpoint":"/automations/{workflow_id}/emails/{workflow_email_id}","verb":"get","tags":["automations"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.automations.getWorkflowEmail(\n    \"workflow_id\",\n    \"Rozella17@yahoo.com\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->automations->getWorkflowEmail(\n    \"workflow_id\",\n    \"Aylin48@yahoo.com\"\n);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.automations.get_workflow_email(\"workflow_id\", \"Ernie.Marks81@yahoo.com\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.automations.get_workflow_email(\n      'workflow_id',\n      'Benjamin_Schowalter10@gmail.com'\n    )\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  https://${dc}.api.mailchimp.com/3.0/automations/{workflow_id}/emails/{workflow_email_id} \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"deleteAutomationsIdEmailsId","pathRoute":"/automation-email/delete-workflow-email","description":"Removes an individual classic automation workflow email. Emails from certain workflow types, including the Abandoned Cart Email (abandonedCart) and Product Retargeting Email (abandonedBrowse) Workflows, cannot be deleted.","summary":"Delete workflow email","endpoint":"/automations/{workflow_id}/emails/{workflow_email_id}","verb":"delete","tags":["automations"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.automations.deleteWorkflowEmail(\n    \"workflow_id\",\n    \"Abdul.Schuppe96@hotmail.com\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->automations->deleteWorkflowEmail(\n    \"workflow_id\",\n    \"Clarissa.Runolfsson77@yahoo.com\"\n);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.automations.delete_workflow_email(\"workflow_id\", \"Nichole_Zulauf@yahoo.com\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.automations.delete_workflow_email(\n      'workflow_id',\n      'Rolando_Kihn41@yahoo.com'\n    )\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X DELETE \\\n  https://${dc}.api.mailchimp.com/3.0/automations/{workflow_id}/emails/{workflow_email_id} \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"patchAutomationEmailWorkflowId","pathRoute":"/automation-email/update-workflow-email","description":"Update settings for a classic automation workflow email.  Only works with workflows of type: abandonedBrowse, abandonedCart, emailFollowup, or singleWelcome.","summary":"Update workflow email","endpoint":"/automations/{workflow_id}/emails/{workflow_email_id}","verb":"patch","tags":["automations"],"deprecated":null,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.automations.updateWorkflowEmail(\n    \"workflow_id\",\n    \"Dorthy19@gmail.com\",\n    {}\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->automations->updateWorkflowEmail(\n    \"workflow_id\",\n    \"Chauncey.Ullrich@yahoo.com\",\n    []\n);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.automations.update_workflow_email(\"workflow_id\", \"Braulio.Graham@hotmail.com\", {})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.automations.update_workflow_email(\n      'workflow_id',\n      'Eino12@yahoo.com',\n      {}\n    )\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X PATCH \\\n  https://${dc}.api.mailchimp.com/3.0/automations/{workflow_id}/emails/{workflow_email_id} \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"settings\":{\"subject_line\":\"\",\"preview_text\":\"\",\"title\":\"\",\"from_name\":\"\",\"reply_to\":\"\"},\"delay\":{\"amount\":0,\"type\":\"now\",\"direction\":\"after\",\"action\":\"signup\"}}'"}]},{"operationId":"postAutomationsIdEmailsIdActionsPause","pathRoute":"/automation-email/pause-automated-email","description":"Pause an automated email.","summary":"Pause automated email","endpoint":"/automations/{workflow_id}/emails/{workflow_email_id}/actions/pause","verb":"post","tags":["automations"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.automations.pauseWorkflowEmail(\n    \"workflow_id\",\n    \"Cristina.Renner12@gmail.com\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->automations->pauseWorkflowEmail(\n    \"workflow_id\",\n    \"Kayli_Konopelski@gmail.com\"\n);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.automations.pause_workflow_email(\"workflow_id\", \"Gage40@hotmail.com\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.automations.pause_workflow_email(\n      'workflow_id',\n      'Abner65@hotmail.com'\n    )\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n  https://${dc}.api.mailchimp.com/3.0/automations/{workflow_id}/emails/{workflow_email_id}/actions/pause \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"postAutomationsIdEmailsIdActionsStart","pathRoute":"/automation-email/start-automated-email","description":"Start an automated email.","summary":"Start automated email","endpoint":"/automations/{workflow_id}/emails/{workflow_email_id}/actions/start","verb":"post","tags":["automations"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.automations.startWorkflowEmail(\n    \"workflow_id\",\n    \"Ike.Strosin@yahoo.com\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->automations->startWorkflowEmail(\n    \"workflow_id\",\n    \"Judy55@gmail.com\"\n);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.automations.start_workflow_email(\"workflow_id\", \"Erna.McGlynn58@hotmail.com\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.automations.start_workflow_email(\n      'workflow_id',\n      'Lavonne.Boehm2@gmail.com'\n    )\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n  https://${dc}.api.mailchimp.com/3.0/automations/{workflow_id}/emails/{workflow_email_id}/actions/start \\\n  --user \"anystring:${apikey}\"'"}]}],"sectionParent":{"sectionAnchor":"automation","sectionTitle":"Automations"}},{"sectionTitle":"Queue","sectionAnchor":"automation-email-queue","sectionDescription":"Manage list member queues for classic automation emails.","sectionRoute":"/automation-email-queue","paths":[{"operationId":"getAutomationsIdEmailsIdQueue","pathRoute":"/automation-email-queue/list-automated-email-subscribers","description":"Get information about a classic automation email queue.","summary":"List automated email subscribers","endpoint":"/automations/{workflow_id}/emails/{workflow_email_id}/queue","verb":"get","tags":["automations"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.automations.getWorkflowEmailSubscriberQueue(\n    \"workflow_id\",\n    \"Matt.Leannon3@yahoo.com\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->automations->getWorkflowEmailSubscriberQueue(\n    \"workflow_id\",\n    \"Brionna.Daugherty98@yahoo.com\"\n);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.automations.get_workflow_email_subscriber_queue(\"workflow_id\", \"Andres_Corwin@hotmail.com\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.automations.get_workflow_email_subscriber_queue(\n      'workflow_id',\n      'Lynn89@hotmail.com'\n    )\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  https://${dc}.api.mailchimp.com/3.0/automations/{workflow_id}/emails/{workflow_email_id}/queue \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"postAutomationsIdEmailsIdQueue","pathRoute":"/automation-email-queue/add-subscriber-to-workflow-email","description":"Manually add a subscriber to a workflow, bypassing the default trigger settings. You can also use this endpoint to trigger a series of automated emails in an API 3.0 workflow type.","summary":"Add subscriber to workflow email","endpoint":"/automations/{workflow_id}/emails/{workflow_email_id}/queue","verb":"post","tags":["automations"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.automations.addWorkflowEmailSubscriber(\n    \"workflow_id\",\n    \"Julie.Donnelly1@hotmail.com\",\n    { email_address: \"Herminio_Weber29@gmail.com\" }\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->automations->addWorkflowEmailSubscriber(\n    \"workflow_id\",\n    \"Earline20@yahoo.com\",\n    [\"email_address\" => \"Ezequiel_Cartwright7@hotmail.com\"]\n);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.automations.add_workflow_email_subscriber(\"workflow_id\", \"Mikayla56@yahoo.com\", {\"email_address\": \"Gail.Padberg61@hotmail.com\"})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.automations.add_workflow_email_subscriber(\n      'workflow_id',\n      'Alexane_Bode42@hotmail.com',\n      { 'email_address' => 'Al.Cassin19@hotmail.com' }\n    )\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n  https://${dc}.api.mailchimp.com/3.0/automations/{workflow_id}/emails/{workflow_email_id}/queue \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"email_address\":\"\"}'"}]},{"operationId":"getAutomationsIdEmailsIdQueueId","pathRoute":"/automation-email-queue/get-automated-email-subscriber","description":"Get information about a specific subscriber in a classic automation email queue.","summary":"Get automated email subscriber","endpoint":"/automations/{workflow_id}/emails/{workflow_email_id}/queue/{subscriber_hash}","verb":"get","tags":["automations"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.automations.getWorkflowEmailSubscriber(\n    \"workflow_id\",\n    \"Asha_Barton@yahoo.com\",\n    \"subscriber_hash\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->automations->getWorkflowEmailSubscriber(\n    \"workflow_id\",\n    \"Bailey23@hotmail.com\",\n    \"subscriber_hash\"\n);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.automations.get_workflow_email_subscriber(\"workflow_id\", \"Uriel59@gmail.com\", \"subscriber_hash\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.automations.get_workflow_email_subscriber(\n      'workflow_id',\n      'Trey_Kirlin52@hotmail.com',\n      'subscriber_hash'\n    )\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  https://${dc}.api.mailchimp.com/3.0/automations/{workflow_id}/emails/{workflow_email_id}/queue/{subscriber_hash} \\\n  --user \"anystring:${apikey}\"'"}]}],"sectionParent":{"sectionAnchor":"automation","sectionTitle":"Automations"}},{"sectionTitle":"Removed Subscribers","sectionAnchor":"automation-removed-subscribers","sectionDescription":"Remove subscribers from a classic automation workflow.","sectionRoute":"/automation-removed-subscribers","paths":[{"operationId":"getAutomationsIdRemovedSubscribers","pathRoute":"/automation-removed-subscribers/list-subscribers-removed-from-workflow","description":"Get information about subscribers who were removed from a classic automation workflow.","summary":"List subscribers removed from workflow","endpoint":"/automations/{workflow_id}/removed-subscribers","verb":"get","tags":["automations"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.automations.listWorkflowEmailSubscribersRemoved(\n    \"workflow_id\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->automations->listWorkflowEmailSubscribersRemoved(\n    \"workflow_id\"\n);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.automations.list_workflow_email_subscribers_removed(\"workflow_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.automations.list_workflow_email_subscribers_removed('workflow_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  https://${dc}.api.mailchimp.com/3.0/automations/{workflow_id}/removed-subscribers \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"postAutomationsIdRemovedSubscribers","pathRoute":"/automation-removed-subscribers/remove-subscriber-from-workflow","description":"Remove a subscriber from a specific classic automation workflow. You can remove a subscriber at any point in an automation workflow, regardless of how many emails they've been sent from that workflow. Once they're removed, they can never be added back to the same workflow.","summary":"Remove subscriber from workflow","endpoint":"/automations/{workflow_id}/removed-subscribers","verb":"post","tags":["automations"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.automations.removeWorkflowEmailSubscriber(\n    \"workflow_id\",\n    { email_address: \"Lexi_Schamberger0@gmail.com\" }\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->automations->removeWorkflowEmailSubscriber(\"workflow_id\", [\n    \"email_address\" => \"Damaris_Gottlieb5@yahoo.com\",\n]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.automations.remove_workflow_email_subscriber(\"workflow_id\", {\"email_address\": \"Llewellyn_Kuhlman12@yahoo.com\"})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.automations.remove_workflow_email_subscriber(\n      'workflow_id',\n      { 'email_address' => 'Ari62@yahoo.com' }\n    )\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n  https://${dc}.api.mailchimp.com/3.0/automations/{workflow_id}/removed-subscribers \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"email_address\":\"\"}'"}]},{"operationId":"getAutomationsIdRemovedSubscribersId","pathRoute":"/automation-removed-subscribers/get-subscriber-removed-from-workflow","description":"Get information about a specific subscriber who was removed from a classic automation workflow.","summary":"Get subscriber removed from workflow","endpoint":"/automations/{workflow_id}/removed-subscribers/{subscriber_hash}","verb":"get","tags":["automations"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.automations.getRemovedWorkflowEmailSubscriber(\n    \"workflow_id\",\n    \"subscriber_hash\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->automations->getRemovedWorkflowEmailSubscriber(\n    \"workflow_id\",\n    \"subscriber_hash\"\n);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.automations.get_removed_workflow_email_subscriber(\"workflow_id\", \"subscriber_hash\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.automations.get_removed_workflow_email_subscriber(\n      'workflow_id',\n      'subscriber_hash'\n    )\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  https://${dc}.api.mailchimp.com/3.0/automations/{workflow_id}/removed-subscribers/{subscriber_hash} \\\n  --user \"anystring:${apikey}\"'"}]}],"sectionParent":{"sectionAnchor":"automation","sectionTitle":"Automations"}}]},{"sectionTitle":"Batch Operations","sectionAnchor":"batch-operations","sectionDescription":"Use batch operations to complete multiple operations with a single call.","sectionRoute":"/batch-operations","paths":[{"operationId":"getBatches","pathRoute":"/batch-operations/list-batch-requests","description":"Get a summary of batch requests that have been made.","summary":"List batch requests","endpoint":"/batches","verb":"get","tags":["batches"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.batches.list();\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->batches->list();\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.batches.list()\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.batches.list\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/batches?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>&count=10&offset=0' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"postBatches","pathRoute":"/batch-operations/start-batch-operation","description":"Begin processing a batch operations request.","summary":"Start batch operation","endpoint":"/batches","verb":"post","tags":["batches"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.batches.start({\n    operations: [{ method: \"POST\", path: \"/lists\" }],\n  });\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->batches->start([\n    \"operations\" => [[\"method\" => \"POST\", \"path\" => \"/lists\"]],\n]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.batches.start({\"operations\": [{\"method\": \"POST\", \"path\": \"/lists\"}]})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.batches.start(\n      { 'operations' => [{ 'method' => 'POST', 'path' => '/lists' }] }\n    )\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n  https://${dc}.api.mailchimp.com/3.0/batches \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"operations\":[]}'"}]},{"operationId":"getBatchesId","pathRoute":"/batch-operations/get-batch-operation-status","description":"Get the status of a batch request.","summary":"Get batch operation status","endpoint":"/batches/{batch_id}","verb":"get","tags":["batches"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.batches.status(\"batch_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->batches->status(\"batch_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.batches.status(\"batch_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.batches.status('batch_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/batches/{batch_id}?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"deleteBatchesId","pathRoute":"/batch-operations/delete-batch-request","description":"Stops a batch request from running. Since only one batch request is run at a time, this can be used to cancel a long running request. The results of any completed operations will not be available after this call.","summary":"Delete batch request","endpoint":"/batches/{batch_id}","verb":"delete","tags":["batches"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.batches.deleteRequest(\"batch_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->batches->deleteRequest(\"batch_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.batches.delete_request(\"batch_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.batches.delete_request('batch_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X DELETE \\\n  https://${dc}.api.mailchimp.com/3.0/batches/{batch_id} \\\n  --user \"anystring:${apikey}\"'"}]}],"subSections":[]},{"sectionTitle":"Batch Webhooks","sectionAnchor":"batch-webhooks","sectionDescription":"Manage webhooks for batch operations.","sectionRoute":"/batch-webhooks","paths":[{"operationId":"getBatchWebhooks","pathRoute":"/batch-webhooks/list-batch-webhooks","description":"Get all webhooks that have been configured for batches.","summary":"List batch webhooks","endpoint":"/batch-webhooks","verb":"get","tags":["batchWebhooks"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.batchWebhooks.list();\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->batchWebhooks->list();\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.batchWebhooks.list()\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.batchWebhooks.list\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/batch-webhooks?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>&count=10&offset=0' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"postBatchWebhooks","pathRoute":"/batch-webhooks/add-batch-webhook","description":"Configure a webhook that will fire whenever any batch request completes processing.  You may only have a maximum of 20 batch webhooks.","summary":"Add batch webhook","endpoint":"/batch-webhooks","verb":"post","tags":["batchWebhooks"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.batchWebhooks.create({\n    url: \"http://yourdomain.com/webhook\",\n  });\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->batchWebhooks->create([\n    \"url\" => \"http://yourdomain.com/webhook\",\n]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.batchWebhooks.create({\"url\": \"http://yourdomain.com/webhook\"})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.batchWebhooks.create({ 'url' => 'http://yourdomain.com/webhook' })\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n  https://${dc}.api.mailchimp.com/3.0/batch-webhooks \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"url\":\"\",\"enabled\":false}'"}]},{"operationId":"getBatchWebhook","pathRoute":"/batch-webhooks/get-batch-webhook-info","description":"Get information about a specific batch webhook.","summary":"Get batch webhook info","endpoint":"/batch-webhooks/{batch_webhook_id}","verb":"get","tags":["batchWebhooks"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.batchWebhooks.get(\"batch_webhook_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->batchWebhooks->get(\"batch_webhook_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.batchWebhooks.get(\"batch_webhook_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.batchWebhooks.get('batch_webhook_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/batch-webhooks/{batch_webhook_id}?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"patchBatchWebhooks","pathRoute":"/batch-webhooks/update-batch-webhook","description":"Update a webhook that will fire whenever any batch request completes processing.","summary":"Update batch webhook","endpoint":"/batch-webhooks/{batch_webhook_id}","verb":"patch","tags":["batchWebhooks"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.batchWebhooks.update(\"batch_webhook_id\", {});\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->batchWebhooks->update(\"batch_webhook_id\", []);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.batchWebhooks.update(\"batch_webhook_id\", {})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.batchWebhooks.update('batch_webhook_id', {})\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X PATCH \\\n  https://${dc}.api.mailchimp.com/3.0/batch-webhooks/{batch_webhook_id} \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"url\":\"\",\"enabled\":false}'"}]},{"operationId":"deleteBatchWebhookId","pathRoute":"/batch-webhooks/delete-batch-webhook","description":"Remove a batch webhook. Webhooks will no longer be sent to the given URL.","summary":"Delete batch webhook","endpoint":"/batch-webhooks/{batch_webhook_id}","verb":"delete","tags":["batchWebhooks"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.batchWebhooks.remove(\"batch_webhook_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->batchWebhooks->remove(\"batch_webhook_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.batchWebhooks.remove(\"batch_webhook_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.batchWebhooks.remove('batch_webhook_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X DELETE \\\n  https://${dc}.api.mailchimp.com/3.0/batch-webhooks/{batch_webhook_id} \\\n  --user \"anystring:${apikey}\"'"}]}],"subSections":[]},{"sectionTitle":"Campaign Folders","sectionAnchor":"campaign-folders","sectionDescription":"Organize your campaigns using folders.","sectionRoute":"/campaign-folders","paths":[{"operationId":"getCampaignFolders","pathRoute":"/campaign-folders/list-campaign-folders","description":"Get all folders used to organize campaigns.","summary":"List campaign folders","endpoint":"/campaign-folders","verb":"get","tags":["campaignFolders"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.campaignFolders.list();\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->campaignFolders->list();\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.campaignFolders.list()\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.campaignFolders.list\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/campaign-folders?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>&count=10&offset=0' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"postCampaignFolders","pathRoute":"/campaign-folders/add-campaign-folder","description":"Create a new campaign folder.","summary":"Add campaign folder","endpoint":"/campaign-folders","verb":"post","tags":["campaignFolders"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.campaignFolders.create({ name: \"name\" });\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->campaignFolders->create([\"name\" => \"name\"]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.campaignFolders.create({\"name\": \"name\"})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.campaignFolders.create({ 'name' => 'name' })\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n  https://${dc}.api.mailchimp.com/3.0/campaign-folders \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"name\":\"\"}'"}]},{"operationId":"getCampaignFoldersId","pathRoute":"/campaign-folders/get-campaign-folder","description":"Get information about a specific folder used to organize campaigns.","summary":"Get campaign folder","endpoint":"/campaign-folders/{folder_id}","verb":"get","tags":["campaignFolders"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.campaignFolders.get(\"folder_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->campaignFolders->get(\"folder_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.campaignFolders.get(\"folder_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.campaignFolders.get('folder_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/campaign-folders/{folder_id}?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"patchCampaignFoldersId","pathRoute":"/campaign-folders/update-campaign-folder","description":"Update a specific folder used to organize campaigns.","summary":"Update campaign folder","endpoint":"/campaign-folders/{folder_id}","verb":"patch","tags":["campaignFolders"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.campaignFolders.update(\"folder_id\", {\n    name: \"name\",\n  });\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->campaignFolders->update(\"folder_id\", [\"name\" => \"name\"]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.campaignFolders.update(\"folder_id\", {\"name\": \"name\"})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.campaignFolders.update('folder_id', { 'name' => 'name' })\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X PATCH \\\n  https://${dc}.api.mailchimp.com/3.0/campaign-folders/{folder_id} \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"name\":\"\"}'"}]},{"operationId":"deleteCampaignFoldersId","pathRoute":"/campaign-folders/delete-campaign-folder","description":"Delete a specific campaign folder, and mark all the campaigns in the folder as 'unfiled'.","summary":"Delete campaign folder","endpoint":"/campaign-folders/{folder_id}","verb":"delete","tags":["campaignFolders"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.campaignFolders.remove(\"folder_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->campaignFolders->remove(\"folder_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.campaignFolders.remove(\"folder_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.campaignFolders.remove('folder_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X DELETE \\\n  https://${dc}.api.mailchimp.com/3.0/campaign-folders/{folder_id} \\\n  --user \"anystring:${apikey}\"'"}]}],"subSections":[]},{"sectionTitle":"Campaigns","sectionAnchor":"campaigns","sectionDescription":"Campaigns are how you send emails to your Mailchimp list. Use the Campaigns API calls to manage campaigns in your Mailchimp account.","sectionRoute":"/campaigns","paths":[{"operationId":"getCampaigns","pathRoute":"/campaigns/list-campaigns","description":"Get all campaigns in an account.","summary":"List campaigns","endpoint":"/campaigns","verb":"get","tags":["campaigns"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.campaigns.list();\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->campaigns->list();\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.campaigns.list()\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.campaigns.list\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/campaigns?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>&count=10&offset=0&type=<SOME_STRING_VALUE>&status=<SOME_STRING_VALUE>&before_send_time=<SOME_STRING_VALUE>&since_send_time=<SOME_STRING_VALUE>&before_create_time=<SOME_STRING_VALUE>&since_create_time=<SOME_STRING_VALUE>&list_id=<SOME_STRING_VALUE>&folder_id=<SOME_STRING_VALUE>&member_id=<SOME_STRING_VALUE>&sort_field=<SOME_STRING_VALUE>&sort_dir=<SOME_STRING_VALUE>&include_resend_shortcut_eligibility=<SOME_BOOLEAN_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"postCampaigns","pathRoute":"/campaigns/add-campaign","description":"Create a new Mailchimp campaign.","summary":"Add campaign","endpoint":"/campaigns","verb":"post","tags":["campaigns"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.campaigns.create({ type: \"regular\" });\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->campaigns->create([\"type\" => \"variate\"]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.campaigns.create({\"type\": \"variate\"})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.campaigns.create({ 'type' => 'rss' })\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n  https://${dc}.api.mailchimp.com/3.0/campaigns \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"type\":\"regular\",\"recipients\":{\"list_id\":\"\",\"segment_opts\":{\"saved_segment_id\":0,\"match\":\"any\",\"conditions\":[]}},\"settings\":{\"subject_line\":\"\",\"preview_text\":\"\",\"title\":\"\",\"from_name\":\"\",\"reply_to\":\"\",\"use_conversation\":false,\"to_name\":\"\",\"folder_id\":\"\",\"authenticate\":false,\"auto_footer\":false,\"inline_css\":false,\"auto_tweet\":false,\"auto_fb_post\":[],\"fb_comments\":false,\"template_id\":0},\"variate_settings\":{\"winner_criteria\":\"opens\",\"wait_time\":0,\"test_size\":0,\"subject_lines\":[],\"send_times\":[],\"from_names\":[],\"reply_to_addresses\":[]},\"tracking\":{\"opens\":false,\"html_clicks\":false,\"text_clicks\":false,\"goal_tracking\":false,\"ecomm360\":false,\"google_analytics\":\"\",\"clicktale\":\"\",\"salesforce\":{\"campaign\":false,\"notes\":false},\"capsule\":{\"notes\":false}},\"rss_opts\":{\"feed_url\":\"\",\"frequency\":\"daily\",\"schedule\":{\"hour\":0,\"daily_send\":{\"sunday\":false,\"monday\":false,\"tuesday\":false,\"wednesday\":false,\"thursday\":false,\"friday\":false,\"saturday\":false},\"weekly_send_day\":\"sunday\",\"monthly_send_date\":0},\"constrain_rss_img\":false},\"social_card\":{\"image_url\":\"\",\"description\":\"\",\"title\":\"\"},\"content_type\":\"template\"}'"}]},{"operationId":"getCampaignsId","pathRoute":"/campaigns/get-campaign-info","description":"Get information about a specific campaign.","summary":"Get campaign info","endpoint":"/campaigns/{campaign_id}","verb":"get","tags":["campaigns"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.campaigns.get(\"campaign_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->campaigns->get(\"campaign_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.campaigns.get(\"campaign_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.campaigns.get('campaign_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/campaigns/{campaign_id}?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>&include_resend_shortcut_eligibility=<SOME_BOOLEAN_VALUE>&include_resend_shortcut_usage=<SOME_BOOLEAN_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"patchCampaignsId","pathRoute":"/campaigns/update-campaign-settings","description":"Update some or all of the settings for a specific campaign.","summary":"Update campaign settings","endpoint":"/campaigns/{campaign_id}","verb":"patch","tags":["campaigns"],"deprecated":null,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.campaigns.update(\"campaign_id\", {\n    settings: {\n      subject_line: \"subject_line\",\n      from_name: \"from_name\",\n      reply_to: \"reply_to\",\n    },\n  });\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->campaigns->update(\"campaign_id\", [\n    \"settings\" => [\n        \"subject_line\" => \"subject_line\",\n        \"from_name\" => \"from_name\",\n        \"reply_to\" => \"reply_to\",\n    ],\n]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.campaigns.update(\"campaign_id\", {\"settings\": {\"subject_line\": \"subject_line\", \"from_name\": \"from_name\", \"reply_to\": \"reply_to\"}})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.campaigns.update(\n      'campaign_id',\n      {\n        'settings' => {\n          'subject_line' => 'subject_line',\n          'from_name' => 'from_name',\n          'reply_to' => 'reply_to'\n        }\n      }\n    )\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X PATCH \\\n  https://${dc}.api.mailchimp.com/3.0/campaigns/{campaign_id} \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"recipients\":{\"list_id\":\"\",\"segment_opts\":{\"saved_segment_id\":0,\"prebuilt_segment_id\":\"\",\"match\":\"any\",\"conditions\":[]}},\"settings\":{\"subject_line\":\"\",\"preview_text\":\"\",\"title\":\"\",\"from_name\":\"\",\"reply_to\":\"\",\"use_conversation\":false,\"to_name\":\"\",\"folder_id\":\"\",\"authenticate\":false,\"auto_footer\":false,\"inline_css\":false,\"auto_tweet\":false,\"auto_fb_post\":[],\"fb_comments\":false,\"template_id\":0},\"variate_settings\":{\"winner_criteria\":\"opens\",\"wait_time\":0,\"test_size\":0,\"subject_lines\":[],\"send_times\":[],\"from_names\":[],\"reply_to_addresses\":[]},\"tracking\":{\"opens\":false,\"html_clicks\":false,\"text_clicks\":false,\"goal_tracking\":false,\"ecomm360\":false,\"google_analytics\":\"\",\"clicktale\":\"\",\"salesforce\":{\"campaign\":false,\"notes\":false},\"capsule\":{\"notes\":false}},\"rss_opts\":{\"feed_url\":\"\",\"frequency\":\"daily\",\"schedule\":{\"hour\":0,\"daily_send\":{\"sunday\":false,\"monday\":false,\"tuesday\":false,\"wednesday\":false,\"thursday\":false,\"friday\":false,\"saturday\":false},\"weekly_send_day\":\"sunday\",\"monthly_send_date\":0},\"constrain_rss_img\":false},\"social_card\":{\"image_url\":\"\",\"description\":\"\",\"title\":\"\"}}'"}]},{"operationId":"deleteCampaignsId","pathRoute":"/campaigns/delete-campaign","description":"Remove a campaign from your Mailchimp account.","summary":"Delete campaign","endpoint":"/campaigns/{campaign_id}","verb":"delete","tags":["campaigns"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.campaigns.remove(\"campaign_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->campaigns->remove(\"campaign_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.campaigns.remove(\"campaign_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.campaigns.remove('campaign_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X DELETE \\\n  https://${dc}.api.mailchimp.com/3.0/campaigns/{campaign_id} \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"postCampaignsIdActionsCancelSend","pathRoute":"/campaigns/cancel-campaign","description":"Cancel a Regular or Plain-Text Campaign after you send, before all of your recipients receive it. This feature is included with Mailchimp Pro.","summary":"Cancel campaign","endpoint":"/campaigns/{campaign_id}/actions/cancel-send","verb":"post","tags":["campaigns"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.campaigns.cancelSend(\"campaign_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->campaigns->cancelSend(\"campaign_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.campaigns.cancel_send(\"campaign_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.campaigns.cancel_send('campaign_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n  https://${dc}.api.mailchimp.com/3.0/campaigns/{campaign_id}/actions/cancel-send \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"postCampaignsIdActionsSend","pathRoute":"/campaigns/send-campaign","description":"Send a Mailchimp campaign. For RSS Campaigns, the campaign will send according to its schedule. All other campaigns will send immediately.","summary":"Send campaign","endpoint":"/campaigns/{campaign_id}/actions/send","verb":"post","tags":["campaigns"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.campaigns.send(\"campaign_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->campaigns->send(\"campaign_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.campaigns.send(\"campaign_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.campaigns.send('campaign_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n  https://${dc}.api.mailchimp.com/3.0/campaigns/{campaign_id}/actions/send \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"postCampaignsIdActionsSchedule","pathRoute":"/campaigns/schedule-campaign","description":"Schedule a campaign for delivery. If you're using Multivariate Campaigns to test send times or sending RSS Campaigns, use the send action instead.","summary":"Schedule campaign","endpoint":"/campaigns/{campaign_id}/actions/schedule","verb":"post","tags":["campaigns"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.campaigns.schedule(\"campaign_id\", {\n    schedule_time: \"2025-06-23T13:19:48.809Z\",\n  });\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->campaigns->schedule(\"campaign_id\", [\n    \"schedule_time\" => \"2025-06-23T13:19:48.812Z\",\n]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.campaigns.schedule(\"campaign_id\", {\"schedule_time\": \"2025-06-23T13:19:48.815Z\"})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.campaigns.schedule(\n      'campaign_id',\n      { 'schedule_time' => '2025-06-23T13:19:48.815Z' }\n    )\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n  https://${dc}.api.mailchimp.com/3.0/campaigns/{campaign_id}/actions/schedule \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"schedule_time\":\"\",\"timewarp\":false,\"batch_delivery\":{\"batch_delay\":0,\"batch_count\":0}}'"}]},{"operationId":"postCampaignsIdActionsUnschedule","pathRoute":"/campaigns/unschedule-campaign","description":"Unschedule a scheduled campaign that hasn't started sending.","summary":"Unschedule campaign","endpoint":"/campaigns/{campaign_id}/actions/unschedule","verb":"post","tags":["campaigns"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.campaigns.unschedule(\"campaign_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->campaigns->unschedule(\"campaign_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.campaigns.unschedule(\"campaign_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.campaigns.unschedule('campaign_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n  https://${dc}.api.mailchimp.com/3.0/campaigns/{campaign_id}/actions/unschedule \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"postCampaignsIdActionsPause","pathRoute":"/campaigns/pause-rss-campaign","description":"Pause an RSS-Driven campaign.","summary":"Pause rss campaign","endpoint":"/campaigns/{campaign_id}/actions/pause","verb":"post","tags":["campaigns"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.campaigns.pause(\"campaign_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->campaigns->pause(\"campaign_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.campaigns.pause(\"campaign_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.campaigns.pause('campaign_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n  https://${dc}.api.mailchimp.com/3.0/campaigns/{campaign_id}/actions/pause \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"postCampaignsIdActionsResume","pathRoute":"/campaigns/resume-rss-campaign","description":"Resume an RSS-Driven campaign.","summary":"Resume rss campaign","endpoint":"/campaigns/{campaign_id}/actions/resume","verb":"post","tags":["campaigns"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.campaigns.resume(\"campaign_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->campaigns->resume(\"campaign_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.campaigns.resume(\"campaign_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.campaigns.resume('campaign_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n  https://${dc}.api.mailchimp.com/3.0/campaigns/{campaign_id}/actions/resume \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"postCampaignsIdActionsReplicate","pathRoute":"/campaigns/replicate-campaign","description":"Replicate a campaign in saved or send status.","summary":"Replicate campaign","endpoint":"/campaigns/{campaign_id}/actions/replicate","verb":"post","tags":["campaigns"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.campaigns.replicate(\"campaign_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->campaigns->replicate(\"campaign_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.campaigns.replicate(\"campaign_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.campaigns.replicate('campaign_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n  https://${dc}.api.mailchimp.com/3.0/campaigns/{campaign_id}/actions/replicate \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"postCampaignsIdActionsTest","pathRoute":"/campaigns/send-test-email","description":"Send a test email.","summary":"Send test email","endpoint":"/campaigns/{campaign_id}/actions/test","verb":"post","tags":["campaigns"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.campaigns.sendTestEmail(\"campaign_id\", {\n    test_emails: [\"Norval_Daniel@hotmail.com\"],\n    send_type: \"plaintext\",\n  });\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->campaigns->sendTestEmail(\"campaign_id\", [\n    \"test_emails\" => [\"Eveline.Blanda@yahoo.com\"],\n    \"send_type\" => \"plaintext\",\n]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.campaigns.send_test_email(\"campaign_id\", {\"test_emails\": [\"Lila_Weissnat@gmail.com\"], \"send_type\": \"plaintext\"})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.campaigns.send_test_email(\n      'campaign_id',\n      { 'test_emails' => %w[Arturo_Erdman@yahoo.com], 'send_type' => 'html' }\n    )\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n  https://${dc}.api.mailchimp.com/3.0/campaigns/{campaign_id}/actions/test \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"test_emails\":[],\"send_type\":\"html\"}'"}]},{"operationId":"postCampaignsIdActionsCreateResend","pathRoute":"/campaigns/resend-campaign","description":"Remove the guesswork for resending a campaign to certain segments. You can use this endpoint as a shortcut to replicate a campaign and resend it to common segments, such as those who didn't open the campaign, or any new subscribers since it was sent.","summary":"Resend campaign","endpoint":"/campaigns/{campaign_id}/actions/create-resend","verb":"post","tags":["campaigns"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.campaigns.createResend(\"campaign_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->campaigns->createResend(\"campaign_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.campaigns.create_resend(\"campaign_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.campaigns.create_resend('campaign_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n  https://${dc}.api.mailchimp.com/3.0/campaigns/{campaign_id}/actions/create-resend \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"shortcut_type\":\"to_non_openers\"}'"}]}],"subSections":[{"sectionTitle":"Content","sectionAnchor":"campaign-content","sectionDescription":"Manage the HTML, plain-text, and template content for your Mailchimp campaigns.","sectionRoute":"/campaign-content","paths":[{"operationId":"getCampaignsIdContent","pathRoute":"/campaign-content/get-campaign-content","description":"Get the the HTML and plain-text content for a campaign.","summary":"Get campaign content","endpoint":"/campaigns/{campaign_id}/content","verb":"get","tags":["campaigns"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.campaigns.getContent(\"campaign_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->campaigns->getContent(\"campaign_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.campaigns.get_content(\"campaign_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.campaigns.get_content('campaign_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/campaigns/{campaign_id}/content?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"putCampaignsIdContent","pathRoute":"/campaign-content/set-campaign-content","description":"Set the content for a campaign.","summary":"Set campaign content","endpoint":"/campaigns/{campaign_id}/content","verb":"put","tags":["campaigns"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.campaigns.setContent(\"campaign_id\", {});\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->campaigns->setContent(\"campaign_id\", []);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.campaigns.set_content(\"campaign_id\", {})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.campaigns.set_content('campaign_id', {})\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X PUT \\\n  https://${dc}.api.mailchimp.com/3.0/campaigns/{campaign_id}/content \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"plain_text\":\"\",\"html\":\"\",\"url\":\"\",\"template\":{\"id\":0,\"sections\":{}},\"archive\":{\"archive_content\":\"\",\"archive_type\":\"zip\"},\"variate_contents\":[]}'"}]}],"sectionParent":{"sectionAnchor":"campaigns","sectionTitle":"Campaigns"}},{"sectionTitle":"Feedback","sectionAnchor":"campaign-feedback","sectionDescription":"Post comments, reply to team feedback, and send test emails while you're working together on a Mailchimp campaign.","sectionRoute":"/campaign-feedback","paths":[{"operationId":"getCampaignsIdFeedback","pathRoute":"/campaign-feedback/list-campaign-feedback","description":"Get team feedback while you're working together on a Mailchimp campaign.","summary":"List campaign feedback","endpoint":"/campaigns/{campaign_id}/feedback","verb":"get","tags":["campaigns"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.campaigns.getFeedback(\"campaign_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->campaigns->getFeedback(\"campaign_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.campaigns.get_feedback(\"campaign_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.campaigns.get_feedback('campaign_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/campaigns/{campaign_id}/feedback?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"postCampaignsIdFeedback","pathRoute":"/campaign-feedback/add-campaign-feedback","description":"Add feedback on a specific campaign.","summary":"Add campaign feedback","endpoint":"/campaigns/{campaign_id}/feedback","verb":"post","tags":["campaigns"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.campaigns.addFeedback(\"campaign_id\", {\n    message: \"message\",\n  });\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->campaigns->addFeedback(\"campaign_id\", [\n    \"message\" => \"message\",\n]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.campaigns.add_feedback(\"campaign_id\", {\"message\": \"message\"})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.campaigns.add_feedback('campaign_id', { 'message' => 'message' })\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n  https://${dc}.api.mailchimp.com/3.0/campaigns/{campaign_id}/feedback \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"block_id\":0,\"message\":\"\",\"is_complete\":false}'"}]},{"operationId":"getCampaignsIdFeedbackId","pathRoute":"/campaign-feedback/get-campaign-feedback-message","description":"Get a specific feedback message from a campaign.","summary":"Get campaign feedback message","endpoint":"/campaigns/{campaign_id}/feedback/{feedback_id}","verb":"get","tags":["campaigns"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.campaigns.getFeedbackMessage(\n    \"campaign_id\",\n    \"feedback_id\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->campaigns->getFeedbackMessage(\n    \"campaign_id\",\n    \"feedback_id\"\n);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.campaigns.get_feedback_message(\"campaign_id\", \"feedback_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.campaigns.get_feedback_message('campaign_id', 'feedback_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/campaigns/{campaign_id}/feedback/{feedback_id}?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"patchCampaignsIdFeedbackId","pathRoute":"/campaign-feedback/update-campaign-feedback-message","description":"Update a specific feedback message for a campaign.","summary":"Update campaign feedback message","endpoint":"/campaigns/{campaign_id}/feedback/{feedback_id}","verb":"patch","tags":["campaigns"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.campaigns.updateFeedbackMessage(\n    \"campaign_id\",\n    \"feedback_id\",\n    {}\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->campaigns->updateFeedbackMessage(\n    \"campaign_id\",\n    \"feedback_id\",\n    []\n);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.campaigns.update_feedback_message(\"campaign_id\", \"feedback_id\", {})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.campaigns.update_feedback_message('campaign_id', 'feedback_id', {})\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X PATCH \\\n  https://${dc}.api.mailchimp.com/3.0/campaigns/{campaign_id}/feedback/{feedback_id} \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"block_id\":0,\"message\":\"\",\"is_complete\":false}'"}]},{"operationId":"deleteCampaignsIdFeedbackId","pathRoute":"/campaign-feedback/delete-campaign-feedback-message","description":"Remove a specific feedback message for a campaign.","summary":"Delete campaign feedback message","endpoint":"/campaigns/{campaign_id}/feedback/{feedback_id}","verb":"delete","tags":["campaigns"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.campaigns.deleteFeedbackMessage(\n    \"campaign_id\",\n    \"feedback_id\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->campaigns->deleteFeedbackMessage(\n    \"campaign_id\",\n    \"feedback_id\"\n);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.campaigns.delete_feedback_message(\"campaign_id\", \"feedback_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.campaigns.delete_feedback_message('campaign_id', 'feedback_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X DELETE \\\n  https://${dc}.api.mailchimp.com/3.0/campaigns/{campaign_id}/feedback/{feedback_id} \\\n  --user \"anystring:${apikey}\"'"}]}],"sectionParent":{"sectionAnchor":"campaigns","sectionTitle":"Campaigns"}},{"sectionTitle":"Send Checklist","sectionAnchor":"campaign-checklist","sectionDescription":"Review the send checklist for your campaign, and resolve any issues before sending.","sectionRoute":"/campaign-checklist","paths":[{"operationId":"getCampaignsIdSendChecklist","pathRoute":"/campaign-checklist/get-campaign-send-checklist","description":"Review the send checklist for a campaign, and resolve any issues before sending.","summary":"Get campaign send checklist","endpoint":"/campaigns/{campaign_id}/send-checklist","verb":"get","tags":["campaigns"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.campaigns.getSendChecklist(\"campaign_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->campaigns->getSendChecklist(\"campaign_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.campaigns.get_send_checklist(\"campaign_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.campaigns.get_send_checklist('campaign_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/campaigns/{campaign_id}/send-checklist?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]}],"sectionParent":{"sectionAnchor":"campaigns","sectionTitle":"Campaigns"}}]},{"sectionTitle":"Chimp Chatter Activity","sectionAnchor":"chimp-chatter","sectionDescription":"Get the latest Chimp Chatter activity from your account.","sectionRoute":"/chimp-chatter","paths":[{"operationId":"getActivityFeedChimpChatter","pathRoute":"/chimp-chatter/get-latest-chimp-chatter","description":"Return the Chimp Chatter for this account ordered by most recent.","summary":"Get latest chimp chatter","endpoint":"/activity-feed/chimp-chatter","verb":"get","tags":["activityFeed"],"deprecated":null,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.activityFeed.getChimpChatter();\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->activityFeed->getChimpChatter();\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.activityFeed.get_chimp_chatter()\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.activityFeed.get_chimp_chatter\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/activity-feed/chimp-chatter?count=10&offset=0' \\\n  --user \"anystring:${apikey}\"'"}]}],"subSections":[]},{"sectionTitle":"Connected Sites","sectionAnchor":"connected-sites","sectionDescription":"Manage sites you've connected to your Mailchimp account.","sectionRoute":"/connected-sites","paths":[{"operationId":"getConnectedSites","pathRoute":"/connected-sites/list-connected-sites","description":"Get all connected sites in an account.","summary":"List connected sites","endpoint":"/connected-sites","verb":"get","tags":["connectedSites"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.connectedSites.list();\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->connectedSites->list();\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.connectedSites.list()\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.connectedSites.list\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/connected-sites?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>&count=10&offset=0' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"postConnectedSites","pathRoute":"/connected-sites/add-connected-site","description":"Create a new Mailchimp connected site.","summary":"Add connected site","endpoint":"/connected-sites","verb":"post","tags":["connectedSites"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.connectedSites.create({\n    foreign_id: \"MC001\",\n    domain: \"example.com\",\n  });\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->connectedSites->create([\n    \"foreign_id\" => \"MC001\",\n    \"domain\" => \"example.com\",\n]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.connectedSites.create({\"foreign_id\": \"MC001\", \"domain\": \"example.com\"})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.connectedSites.create(\n      { 'foreign_id' => 'MC001', 'domain' => 'example.com' }\n    )\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n  https://${dc}.api.mailchimp.com/3.0/connected-sites \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"foreign_id\":\"\",\"domain\":\"\"}'"}]},{"operationId":"getConnectedSitesId","pathRoute":"/connected-sites/get-connected-site","description":"Get information about a specific connected site.","summary":"Get connected site","endpoint":"/connected-sites/{connected_site_id}","verb":"get","tags":["connectedSites"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.connectedSites.get(\"connected_site_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->connectedSites->get(\"connected_site_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.connectedSites.get(\"connected_site_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.connectedSites.get('connected_site_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/connected-sites/{connected_site_id}?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"deleteConnectedSitesId","pathRoute":"/connected-sites/delete-connected-site","description":"Remove a connected site from your Mailchimp account.","summary":"Delete connected site","endpoint":"/connected-sites/{connected_site_id}","verb":"delete","tags":["connectedSites"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.connectedSites.remove(\"connected_site_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->connectedSites->remove(\"connected_site_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.connectedSites.remove(\"connected_site_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.connectedSites.remove('connected_site_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X DELETE \\\n  https://${dc}.api.mailchimp.com/3.0/connected-sites/{connected_site_id} \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"postConnectedSitesIdActionsVerifyScriptInstallation","pathRoute":"/connected-sites/verify-connected-site-script","description":"Verify that the connected sites script has been installed, either via the script URL or fragment.","summary":"Verify connected site script","endpoint":"/connected-sites/{connected_site_id}/actions/verify-script-installation","verb":"post","tags":["connectedSites"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.connectedSites.verifyScriptInstallation(\n    \"connected_site_id\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->connectedSites->verifyScriptInstallation(\n    \"connected_site_id\"\n);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.connectedSites.verify_script_installation(\"connected_site_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.connectedSites.verify_script_installation('connected_site_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n  https://${dc}.api.mailchimp.com/3.0/connected-sites/{connected_site_id}/actions/verify-script-installation \\\n  --user \"anystring:${apikey}\"'"}]}],"subSections":[]},{"sectionTitle":"Conversations","sectionAnchor":"conversations","sectionDescription":"Conversation tracking lets you view subscribers' replies to your campaigns in your Mailchimp account.","sectionRoute":"/conversations","paths":[{"operationId":"getConversations","pathRoute":"/conversations/list-conversations","description":"Get a list of conversations for the account. Conversations has been deprecated in favor of Inbox and these endpoints don't include Inbox data. Past Conversations are still available via this endpoint, but new campaign replies and other Inbox messages aren’t available using this endpoint.","summary":"List conversations","endpoint":"/conversations","verb":"get","tags":["conversations"],"deprecated":true,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.conversations.list();\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->conversations->list();\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.conversations.list()\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.conversations.list\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/conversations?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>&count=10&offset=0&has_unread_messages=<SOME_STRING_VALUE>&list_id=<SOME_STRING_VALUE>&campaign_id=<SOME_STRING_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"getConversationsId","pathRoute":"/conversations/get-conversation","description":"Get details about an individual conversation. Conversations has been deprecated in favor of Inbox and these endpoints don't include Inbox data. Past Conversations are still available via this endpoint, but new campaign replies and other Inbox messages aren’t available using this endpoint.","summary":"Get conversation","endpoint":"/conversations/{conversation_id}","verb":"get","tags":["conversations"],"deprecated":true,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.conversations.get(\"conversation_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->conversations->get(\"conversation_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.conversations.get(\"conversation_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.conversations.get('conversation_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/conversations/{conversation_id}?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]}],"subSections":[{"sectionTitle":"Messages","sectionAnchor":"conversation-messages","sectionDescription":"Manage messages in a specific campaign conversation.","sectionRoute":"/conversation-messages","paths":[{"operationId":"getConversationsIdMessages","pathRoute":"/conversation-messages/list-messages","description":"Get messages from a specific conversation. Conversations has been deprecated in favor of Inbox and these endpoints don't include Inbox data. Past Conversations are still available via this endpoint, but new campaign replies and other Inbox messages aren’t available using this endpoint.","summary":"List messages","endpoint":"/conversations/{conversation_id}/messages","verb":"get","tags":["conversations"],"deprecated":true,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.conversations.getConversationMessages(\n    \"conversation_id\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->conversations->getConversationMessages(\"conversation_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.conversations.get_conversation_messages(\"conversation_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.conversations.get_conversation_messages('conversation_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/conversations/{conversation_id}/messages?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>&is_read=<SOME_STRING_VALUE>&before_timestamp=<SOME_STRING_VALUE>&since_timestamp=<SOME_STRING_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"getConversationsIdMessagesId","pathRoute":"/conversation-messages/get-message","description":"Get an individual message in a conversation. Conversations has been deprecated in favor of Inbox and these endpoints don't include Inbox data. Past Conversations are still available via this endpoint, but new campaign replies and other Inbox messages aren’t available using this endpoint.","summary":"Get message","endpoint":"/conversations/{conversation_id}/messages/{message_id}","verb":"get","tags":["conversations"],"deprecated":true,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.conversations.getConversationMessage(\n    \"conversation_id\",\n    \"message_id\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->conversations->getConversationMessage(\n    \"conversation_id\",\n    \"message_id\"\n);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.conversations.get_conversation_message(\"conversation_id\", \"message_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.conversations.get_conversation_message(\n      'conversation_id',\n      'message_id'\n    )\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/conversations/{conversation_id}/messages/{message_id}?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]}],"sectionParent":{"sectionAnchor":"conversations","sectionTitle":"Conversations"}}]},{"sectionTitle":"E-commerce Stores","sectionAnchor":"ecommerce-stores","sectionDescription":"Connect your E-commerce Store to Mailchimp to take advantage of powerful reporting and personalization features and to learn more about your customers.","sectionRoute":"/ecommerce-stores","paths":[{"operationId":"getEcommerceStores","pathRoute":"/ecommerce-stores/list-stores","description":"Get information about all stores in the account.","summary":"List stores","endpoint":"/ecommerce/stores","verb":"get","tags":["ecommerce"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.ecommerce.stores();\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->ecommerce->stores();\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.ecommerce.stores()\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.ecommerce.stores\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/ecommerce/stores?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>&count=10&offset=0' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"postEcommerceStores","pathRoute":"/ecommerce-stores/add-store","description":"Add a new store to your Mailchimp account.","summary":"Add store","endpoint":"/ecommerce/stores","verb":"post","tags":["ecommerce"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.ecommerce.addStore({\n    id: \"example_store\",\n    list_id: \"1a2df69511\",\n    name: \"Freddie's Cat Hat Emporium\",\n    currency_code: \"USD\",\n  });\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->ecommerce->addStore([\n    \"id\" => \"example_store\",\n    \"list_id\" => \"1a2df69511\",\n    \"name\" => \"Freddie's Cat Hat Emporium\",\n    \"currency_code\" => \"USD\",\n]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.ecommerce.add_store({\"id\": \"example_store\", \"list_id\": \"1a2df69511\", \"name\": \"Freddie's Cat Hat Emporium\", \"currency_code\": \"USD\"})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.ecommerce.add_store(\n      {\n        'id' => 'example_store',\n        'list_id' => '1a2df69511',\n        'name' => \"Freddie's Cat Hat Emporium\",\n        'currency_code' => 'USD'\n      }\n    )\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n  https://${dc}.api.mailchimp.com/3.0/ecommerce/stores \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"id\":\"\",\"list_id\":\"\",\"name\":\"\",\"platform\":\"\",\"domain\":\"\",\"is_syncing\":false,\"email_address\":\"\",\"currency_code\":\"\",\"money_format\":\"\",\"primary_locale\":\"\",\"timezone\":\"\",\"phone\":\"\",\"address\":{\"address1\":\"\",\"address2\":\"\",\"city\":\"\",\"province\":\"\",\"province_code\":\"\",\"postal_code\":\"\",\"country\":\"\",\"country_code\":\"\",\"longitude\":0,\"latitude\":0}}'"}]},{"operationId":"getEcommerceStoresId","pathRoute":"/ecommerce-stores/get-store-info","description":"Get information about a specific store.","summary":"Get store info","endpoint":"/ecommerce/stores/{store_id}","verb":"get","tags":["ecommerce"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.ecommerce.getStore(\"store_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->ecommerce->getStore(\"store_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.ecommerce.get_store(\"store_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.ecommerce.get_store('store_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/ecommerce/stores/{store_id}?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"patchEcommerceStoresId","pathRoute":"/ecommerce-stores/update-store","description":"Update a store.","summary":"Update store","endpoint":"/ecommerce/stores/{store_id}","verb":"patch","tags":["ecommerce"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.ecommerce.updateStore(\"store_id\", {});\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->ecommerce->updateStore(\"store_id\", []);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.ecommerce.update_store(\"store_id\", {})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.ecommerce.update_store('store_id', {})\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X PATCH \\\n  https://${dc}.api.mailchimp.com/3.0/ecommerce/stores/{store_id} \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"name\":\"\",\"platform\":\"\",\"domain\":\"\",\"is_syncing\":false,\"email_address\":\"\",\"currency_code\":\"\",\"money_format\":\"\",\"primary_locale\":\"\",\"timezone\":\"\",\"phone\":\"\",\"address\":{\"address1\":\"\",\"address2\":\"\",\"city\":\"\",\"province\":\"\",\"province_code\":\"\",\"postal_code\":\"\",\"country\":\"\",\"country_code\":\"\",\"longitude\":0,\"latitude\":0}}'"}]},{"operationId":"deleteEcommerceStoresId","pathRoute":"/ecommerce-stores/delete-store","description":"Delete a store. Deleting a store will also delete any associated subresources, including Customers, Orders, Products, and Carts.","summary":"Delete store","endpoint":"/ecommerce/stores/{store_id}","verb":"delete","tags":["ecommerce"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.ecommerce.deleteStore(\"store_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->ecommerce->deleteStore(\"store_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.ecommerce.delete_store(\"store_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.ecommerce.delete_store('store_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X DELETE \\\n  https://${dc}.api.mailchimp.com/3.0/ecommerce/stores/{store_id} \\\n  --user \"anystring:${apikey}\"'"}]}],"subSections":[{"sectionTitle":"Cart Lines","sectionAnchor":"ecommerce-cart-lines","sectionDescription":"Each Cart contains one or more Cart Lines, which represent a specific Product Variant that a Customer has added to their shopping cart.","sectionRoute":"/ecommerce-cart-lines","paths":[{"operationId":"getEcommerceStoresIdCartsIdLines","pathRoute":"/ecommerce-cart-lines/list-cart-line-items","description":"Get information about a cart's line items.","summary":"List cart line items","endpoint":"/ecommerce/stores/{store_id}/carts/{cart_id}/lines","verb":"get","tags":["ecommerce"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.ecommerce.getAllCartLineItems(\n    \"store_id\",\n    \"cart_id\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->ecommerce->getAllCartLineItems(\"store_id\", \"cart_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.ecommerce.get_all_cart_line_items(\"store_id\", \"cart_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.ecommerce.get_all_cart_line_items('store_id', 'cart_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/ecommerce/stores/{store_id}/carts/{cart_id}/lines?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>&count=10&offset=0' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"postEcommerceStoresIdCartsIdLines","pathRoute":"/ecommerce-cart-lines/add-cart-line-item","description":"Add a new line item to an existing cart.","summary":"Add cart line item","endpoint":"/ecommerce/stores/{store_id}/carts/{cart_id}/lines","verb":"post","tags":["ecommerce"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.ecommerce.addCartLineItem(\n    \"store_id\",\n    \"cart_id\",\n    {\n      id: \"id\",\n      product_id: \"product_id\",\n      product_variant_id: \"product_variant_id\",\n      quantity: 31360,\n      price: 9551,\n    }\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->ecommerce->addCartLineItem(\"store_id\", \"cart_id\", [\n    \"id\" => \"id\",\n    \"product_id\" => \"product_id\",\n    \"product_variant_id\" => \"product_variant_id\",\n    \"quantity\" => 12469,\n    \"price\" => 36601,\n]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.ecommerce.add_cart_line_item(\"store_id\", \"cart_id\", {\"id\": \"id\", \"product_id\": \"product_id\", \"product_variant_id\": \"product_variant_id\", \"quantity\": 72437, \"price\": 1042})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.ecommerce.add_cart_line_item(\n      'store_id',\n      'cart_id',\n      {\n        'id' => 'id',\n        'product_id' => 'product_id',\n        'product_variant_id' => 'product_variant_id',\n        'quantity' => 80_854,\n        'price' => 26_565\n      }\n    )\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n  https://${dc}.api.mailchimp.com/3.0/ecommerce/stores/{store_id}/carts/{cart_id}/lines \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"id\":\"\",\"product_id\":\"\",\"product_variant_id\":\"\",\"quantity\":0,\"price\":0}'"}]},{"operationId":"getEcommerceStoresIdCartsIdLinesId","pathRoute":"/ecommerce-cart-lines/get-cart-line-item","description":"Get information about a specific cart line item.","summary":"Get cart line item","endpoint":"/ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id}","verb":"get","tags":["ecommerce"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.ecommerce.getCartLineItem(\n    \"store_id\",\n    \"cart_id\",\n    \"line_id\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->ecommerce->getCartLineItem(\n    \"store_id\",\n    \"cart_id\",\n    \"line_id\"\n);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.ecommerce.get_cart_line_item(\"store_id\", \"cart_id\", \"line_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.ecommerce.get_cart_line_item('store_id', 'cart_id', 'line_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id}?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"patchEcommerceStoresIdCartsIdLinesId","pathRoute":"/ecommerce-cart-lines/update-cart-line-item","description":"Update a specific cart line item.","summary":"Update cart line item","endpoint":"/ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id}","verb":"patch","tags":["ecommerce"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.ecommerce.updateCartLineItem(\n    \"store_id\",\n    \"cart_id\",\n    \"line_id\",\n    {}\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->ecommerce->updateCartLineItem(\n    \"store_id\",\n    \"cart_id\",\n    \"line_id\",\n    []\n);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.ecommerce.update_cart_line_item(\"store_id\", \"cart_id\", \"line_id\", {})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.ecommerce.update_cart_line_item('store_id', 'cart_id', 'line_id', {})\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X PATCH \\\n  https://${dc}.api.mailchimp.com/3.0/ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id} \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"product_id\":\"\",\"product_variant_id\":\"\",\"quantity\":0,\"price\":0}'"}]},{"operationId":"deleteEcommerceStoresIdCartsLinesId","pathRoute":"/ecommerce-cart-lines/delete-cart-line-item","description":"Delete a specific cart line item.","summary":"Delete cart line item","endpoint":"/ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id}","verb":"delete","tags":["ecommerce"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.ecommerce.deleteCartLineItem(\n    \"store_id\",\n    \"cart_id\",\n    \"line_id\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->ecommerce->deleteCartLineItem(\n    \"store_id\",\n    \"cart_id\",\n    \"line_id\"\n);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.ecommerce.delete_cart_line_item(\"store_id\", \"cart_id\", \"line_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.ecommerce.delete_cart_line_item('store_id', 'cart_id', 'line_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X DELETE \\\n  https://${dc}.api.mailchimp.com/3.0/ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id} \\\n  --user \"anystring:${apikey}\"'"}]}],"sectionParent":{"sectionAnchor":"ecommerce-stores","sectionTitle":"E-commerce Stores"}},{"sectionTitle":"Carts","sectionAnchor":"ecommerce-carts","sectionDescription":"Use Carts to represent unfinished e-commerce transactions. This can be used to create an Abandoned Cart workflow, or to save a consumer’s shopping cart pending a successful Order.","sectionRoute":"/ecommerce-carts","paths":[{"operationId":"getEcommerceStoresIdCarts","pathRoute":"/ecommerce-carts/list-carts","description":"Get information about a store's carts.","summary":"List carts","endpoint":"/ecommerce/stores/{store_id}/carts","verb":"get","tags":["ecommerce"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.ecommerce.getStoreCarts(\"store_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->ecommerce->getStoreCarts(\"store_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.ecommerce.get_store_carts(\"store_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.ecommerce.get_store_carts('store_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/ecommerce/stores/{store_id}/carts?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>&count=10&offset=0' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"postEcommerceStoresIdCarts","pathRoute":"/ecommerce-carts/add-cart","description":"Add a new cart to a store.","summary":"Add cart","endpoint":"/ecommerce/stores/{store_id}/carts","verb":"post","tags":["ecommerce"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.ecommerce.addStoreCart(\"store_id\", {\n    id: \"id\",\n    currency_code: \"currency_code\",\n    customer: { id: \"id\" },\n    order_total: 37770,\n    lines: [\n      {\n        id: \"id\",\n        product_id: \"product_id\",\n        product_variant_id: \"product_variant_id\",\n        quantity: 73426,\n        price: 68360,\n      },\n    ],\n  });\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->ecommerce->addStoreCart(\"store_id\", [\n    \"id\" => \"id\",\n    \"currency_code\" => \"currency_code\",\n    \"customer\" => [\"id\" => \"id\"],\n    \"order_total\" => 42779,\n    \"lines\" => [\n        [\n            \"id\" => \"id\",\n            \"product_id\" => \"product_id\",\n            \"product_variant_id\" => \"product_variant_id\",\n            \"quantity\" => 91921,\n            \"price\" => 61482,\n        ],\n    ],\n]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.ecommerce.add_store_cart(\"store_id\", {\"id\": \"id\", \"currency_code\": \"currency_code\", \"customer\": {\"id\": \"id\"}, \"order_total\": 4637, \"lines\": [{\"id\": \"id\", \"product_id\": \"product_id\", \"product_variant_id\": \"product_variant_id\", \"quantity\": 37693, \"price\": 82329}]})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.ecommerce.add_store_cart(\n      'store_id',\n      {\n        'id' => 'id',\n        'currency_code' => 'currency_code',\n        'customer' => { 'id' => 'id' },\n        'order_total' => 24_609,\n        'lines' => [\n          {\n            'id' => 'id',\n            'product_id' => 'product_id',\n            'product_variant_id' => 'product_variant_id',\n            'quantity' => 71_675,\n            'price' => 11_211\n          }\n        ]\n      }\n    )\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n  https://${dc}.api.mailchimp.com/3.0/ecommerce/stores/{store_id}/carts \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"id\":\"\",\"customer\":{\"id\":\"\",\"email_address\":\"\",\"opt_in_status\":false,\"company\":\"\",\"first_name\":\"\",\"last_name\":\"\",\"address\":{\"address1\":\"\",\"address2\":\"\",\"city\":\"\",\"province\":\"\",\"province_code\":\"\",\"postal_code\":\"\",\"country\":\"\",\"country_code\":\"\"}},\"campaign_id\":\"\",\"checkout_url\":\"\",\"currency_code\":\"\",\"order_total\":0,\"tax_total\":0,\"lines\":[]}'"}]},{"operationId":"getEcommerceStoresIdCartsId","pathRoute":"/ecommerce-carts/get-cart-info","description":"Get information about a specific cart.","summary":"Get cart info","endpoint":"/ecommerce/stores/{store_id}/carts/{cart_id}","verb":"get","tags":["ecommerce"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.ecommerce.getStoreCart(\"store_id\", \"cart_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->ecommerce->getStoreCart(\"store_id\", \"cart_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.ecommerce.get_store_cart(\"store_id\", \"cart_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.ecommerce.get_store_cart('store_id', 'cart_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/ecommerce/stores/{store_id}/carts/{cart_id}?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"patchEcommerceStoresIdCartsId","pathRoute":"/ecommerce-carts/update-cart","description":"Update a specific cart.","summary":"Update cart","endpoint":"/ecommerce/stores/{store_id}/carts/{cart_id}","verb":"patch","tags":["ecommerce"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.ecommerce.updateStoreCart(\n    \"store_id\",\n    \"cart_id\",\n    {}\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->ecommerce->updateStoreCart(\"store_id\", \"cart_id\", []);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.ecommerce.update_store_cart(\"store_id\", \"cart_id\", {})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.ecommerce.update_store_cart('store_id', 'cart_id', {})\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X PATCH \\\n  https://${dc}.api.mailchimp.com/3.0/ecommerce/stores/{store_id}/carts/{cart_id} \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"customer\":{\"opt_in_status\":false,\"company\":\"\",\"first_name\":\"\",\"last_name\":\"\",\"address\":{\"address1\":\"\",\"address2\":\"\",\"city\":\"\",\"province\":\"\",\"province_code\":\"\",\"postal_code\":\"\",\"country\":\"\",\"country_code\":\"\"}},\"campaign_id\":\"\",\"checkout_url\":\"\",\"currency_code\":\"\",\"order_total\":0,\"tax_total\":0,\"lines\":[]}'"}]},{"operationId":"deleteEcommerceStoresIdCartsId","pathRoute":"/ecommerce-carts/delete-cart","description":"Delete a cart.","summary":"Delete cart","endpoint":"/ecommerce/stores/{store_id}/carts/{cart_id}","verb":"delete","tags":["ecommerce"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.ecommerce.deleteStoreCart(\n    \"store_id\",\n    \"cart_id\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->ecommerce->deleteStoreCart(\"store_id\", \"cart_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.ecommerce.delete_store_cart(\"store_id\", \"cart_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.ecommerce.delete_store_cart('store_id', 'cart_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X DELETE \\\n  https://${dc}.api.mailchimp.com/3.0/ecommerce/stores/{store_id}/carts/{cart_id} \\\n  --user \"anystring:${apikey}\"'"}]}],"sectionParent":{"sectionAnchor":"ecommerce-stores","sectionTitle":"E-commerce Stores"}},{"sectionTitle":"Customers","sectionAnchor":"ecommerce-customers","sectionDescription":"Add Customers to your Store to track their orders and to view E-Commerce Data for your Mailchimp lists and campaigns. Each Customer is connected to a Mailchimp list member, so adding a Customer can also add or update a list member.","sectionRoute":"/ecommerce-customers","paths":[{"operationId":"getEcommerceStoresIdCustomers","pathRoute":"/ecommerce-customers/list-customers","description":"Get information about a store's customers.","summary":"List customers","endpoint":"/ecommerce/stores/{store_id}/customers","verb":"get","tags":["ecommerce"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.ecommerce.getAllStoreCustomers(\"store_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->ecommerce->getAllStoreCustomers(\"store_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.ecommerce.get_all_store_customers(\"store_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.ecommerce.get_all_store_customers('store_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/ecommerce/stores/{store_id}/customers?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>&count=10&offset=0&email_address=<SOME_STRING_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"postEcommerceStoresIdCustomers","pathRoute":"/ecommerce-customers/add-customer","description":"Add a new customer to a store.","summary":"Add customer","endpoint":"/ecommerce/stores/{store_id}/customers","verb":"post","tags":["ecommerce"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.ecommerce.addStoreCustomer(\"store_id\", {\n    id: \"id\",\n    opt_in_status: true,\n  });\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->ecommerce->addStoreCustomer(\"store_id\", [\n    \"id\" => \"id\",\n    \"opt_in_status\" => true,\n]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.ecommerce.add_store_customer(\"store_id\", {\"id\": \"id\", \"opt_in_status\": true})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.ecommerce.add_store_customer(\n      'store_id',\n      { 'id' => 'id', 'opt_in_status' => false }\n    )\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n  https://${dc}.api.mailchimp.com/3.0/ecommerce/stores/{store_id}/customers \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"id\":\"\",\"email_address\":\"\",\"sms_phone_number\":\"\",\"opt_in_status\":false,\"company\":\"\",\"first_name\":\"\",\"last_name\":\"\",\"address\":{\"address1\":\"\",\"address2\":\"\",\"city\":\"\",\"province\":\"\",\"province_code\":\"\",\"postal_code\":\"\",\"country\":\"\",\"country_code\":\"\"}}'"}]},{"operationId":"getEcommerceStoresIdCustomersId","pathRoute":"/ecommerce-customers/get-customer-info","description":"Get information about a specific customer.","summary":"Get customer info","endpoint":"/ecommerce/stores/{store_id}/customers/{customer_id}","verb":"get","tags":["ecommerce"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.ecommerce.getStoreCustomer(\n    \"store_id\",\n    \"customer_id\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->ecommerce->getStoreCustomer(\"store_id\", \"customer_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.ecommerce.get_store_customer(\"store_id\", \"customer_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.ecommerce.get_store_customer('store_id', 'customer_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/ecommerce/stores/{store_id}/customers/{customer_id}?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"putEcommerceStoresIdCustomersId","pathRoute":"/ecommerce-customers/add-or-update-customer","description":"Add or update a customer.","summary":"Add or update customer","endpoint":"/ecommerce/stores/{store_id}/customers/{customer_id}","verb":"put","tags":["ecommerce"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.ecommerce.setStoreCustomer(\n    \"store_id\",\n    \"customer_id\",\n    { id: \"id\", opt_in_status: false }\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->ecommerce->setStoreCustomer(\"store_id\", \"customer_id\", [\n    \"id\" => \"id\",\n    \"opt_in_status\" => false,\n]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.ecommerce.set_store_customer(\"store_id\", \"customer_id\", {\"id\": \"id\", \"opt_in_status\": true})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.ecommerce.set_store_customer(\n      'store_id',\n      'customer_id',\n      { 'id' => 'id', 'opt_in_status' => true }\n    )\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X PUT \\\n  https://${dc}.api.mailchimp.com/3.0/ecommerce/stores/{store_id}/customers/{customer_id} \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"id\":\"\",\"email_address\":\"\",\"sms_phone_number\":\"\",\"opt_in_status\":false,\"company\":\"\",\"first_name\":\"\",\"last_name\":\"\",\"address\":{\"address1\":\"\",\"address2\":\"\",\"city\":\"\",\"province\":\"\",\"province_code\":\"\",\"postal_code\":\"\",\"country\":\"\",\"country_code\":\"\"}}'"}]},{"operationId":"patchEcommerceStoresIdCustomersId","pathRoute":"/ecommerce-customers/update-customer","description":"Update a customer.","summary":"Update customer","endpoint":"/ecommerce/stores/{store_id}/customers/{customer_id}","verb":"patch","tags":["ecommerce"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.ecommerce.updateStoreCustomer(\n    \"store_id\",\n    \"customer_id\",\n    {}\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->ecommerce->updateStoreCustomer(\n    \"store_id\",\n    \"customer_id\",\n    []\n);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.ecommerce.update_store_customer(\"store_id\", \"customer_id\", {})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.ecommerce.update_store_customer('store_id', 'customer_id', {})\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X PATCH \\\n  https://${dc}.api.mailchimp.com/3.0/ecommerce/stores/{store_id}/customers/{customer_id} \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"opt_in_status\":false,\"company\":\"\",\"first_name\":\"\",\"last_name\":\"\",\"address\":{\"address1\":\"\",\"address2\":\"\",\"city\":\"\",\"province\":\"\",\"province_code\":\"\",\"postal_code\":\"\",\"country\":\"\",\"country_code\":\"\"}}'"}]},{"operationId":"deleteEcommerceStoresIdCustomersId","pathRoute":"/ecommerce-customers/delete-customer","description":"Delete a customer from a store.","summary":"Delete customer","endpoint":"/ecommerce/stores/{store_id}/customers/{customer_id}","verb":"delete","tags":["ecommerce"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.ecommerce.deleteStoreCustomer(\n    \"store_id\",\n    \"customer_id\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->ecommerce->deleteStoreCustomer(\"store_id\", \"customer_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.ecommerce.delete_store_customer(\"store_id\", \"customer_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.ecommerce.delete_store_customer('store_id', 'customer_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X DELETE \\\n  https://${dc}.api.mailchimp.com/3.0/ecommerce/stores/{store_id}/customers/{customer_id} \\\n  --user \"anystring:${apikey}\"'"}]}],"sectionParent":{"sectionAnchor":"ecommerce-stores","sectionTitle":"E-commerce Stores"}},{"sectionTitle":"Order Lines","sectionAnchor":"ecommerce-order-lines","sectionDescription":"Each Order contains one or more Order Lines, which represent a specific Product Variant that a Customer purchases.","sectionRoute":"/ecommerce-order-lines","paths":[{"operationId":"getEcommerceStoresIdOrdersIdLines","pathRoute":"/ecommerce-order-lines/list-order-line-items","description":"Get information about an order's line items.","summary":"List order line items","endpoint":"/ecommerce/stores/{store_id}/orders/{order_id}/lines","verb":"get","tags":["ecommerce"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.ecommerce.getAllOrderLineItems(\n    \"store_id\",\n    \"order_id\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->ecommerce->getAllOrderLineItems(\"store_id\", \"order_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.ecommerce.get_all_order_line_items(\"store_id\", \"order_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.ecommerce.get_all_order_line_items('store_id', 'order_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/ecommerce/stores/{store_id}/orders/{order_id}/lines?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>&count=10&offset=0' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"postEcommerceStoresIdOrdersIdLines","pathRoute":"/ecommerce-order-lines/add-order-line-item","description":"Add a new line item to an existing order.","summary":"Add order line item","endpoint":"/ecommerce/stores/{store_id}/orders/{order_id}/lines","verb":"post","tags":["ecommerce"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.ecommerce.addOrderLineItem(\n    \"store_id\",\n    \"order_id\",\n    {\n      id: \"id\",\n      product_id: \"product_id\",\n      product_variant_id: \"product_variant_id\",\n      quantity: 32626,\n      price: 85503,\n    }\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->ecommerce->addOrderLineItem(\"store_id\", \"order_id\", [\n    \"id\" => \"id\",\n    \"product_id\" => \"product_id\",\n    \"product_variant_id\" => \"product_variant_id\",\n    \"quantity\" => 24363,\n    \"price\" => 75735,\n]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.ecommerce.add_order_line_item(\"store_id\", \"order_id\", {\"id\": \"id\", \"product_id\": \"product_id\", \"product_variant_id\": \"product_variant_id\", \"quantity\": 21035, \"price\": 67916})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.ecommerce.add_order_line_item(\n      'store_id',\n      'order_id',\n      {\n        'id' => 'id',\n        'product_id' => 'product_id',\n        'product_variant_id' => 'product_variant_id',\n        'quantity' => 76_046,\n        'price' => 68_949\n      }\n    )\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n  https://${dc}.api.mailchimp.com/3.0/ecommerce/stores/{store_id}/orders/{order_id}/lines \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"id\":\"\",\"product_id\":\"\",\"product_variant_id\":\"\",\"product\":{\"id\":\"\",\"title\":\"\",\"handle\":\"\",\"url\":\"\",\"description\":\"\",\"type\":\"\",\"vendor\":\"\",\"image_url\":\"\",\"variants\":[],\"images\":[],\"published_at_foreign\":\"\"},\"quantity\":0,\"price\":0,\"discount\":0}'"}]},{"operationId":"getEcommerceStoresIdOrdersIdLinesId","pathRoute":"/ecommerce-order-lines/get-order-line-item","description":"Get information about a specific order line item.","summary":"Get order line item","endpoint":"/ecommerce/stores/{store_id}/orders/{order_id}/lines/{line_id}","verb":"get","tags":["ecommerce"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.ecommerce.getOrderLineItem(\n    \"store_id\",\n    \"order_id\",\n    \"line_id\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->ecommerce->getOrderLineItem(\n    \"store_id\",\n    \"order_id\",\n    \"line_id\"\n);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.ecommerce.get_order_line_item(\"store_id\", \"order_id\", \"line_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.ecommerce.get_order_line_item('store_id', 'order_id', 'line_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/ecommerce/stores/{store_id}/orders/{order_id}/lines/{line_id}?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"patchEcommerceStoresIdOrdersIdLinesId","pathRoute":"/ecommerce-order-lines/update-order-line-item","description":"Update a specific order line item.","summary":"Update order line item","endpoint":"/ecommerce/stores/{store_id}/orders/{order_id}/lines/{line_id}","verb":"patch","tags":["ecommerce"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.ecommerce.updateOrderLineItem(\n    \"store_id\",\n    \"order_id\",\n    \"line_id\",\n    {}\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->ecommerce->updateOrderLineItem(\n    \"store_id\",\n    \"order_id\",\n    \"line_id\",\n    []\n);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.ecommerce.update_order_line_item(\"store_id\", \"order_id\", \"line_id\", {})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.ecommerce.update_order_line_item(\n      'store_id',\n      'order_id',\n      'line_id',\n      {}\n    )\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X PATCH \\\n  https://${dc}.api.mailchimp.com/3.0/ecommerce/stores/{store_id}/orders/{order_id}/lines/{line_id} \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"product_id\":\"\",\"product_variant_id\":\"\",\"quantity\":0,\"price\":0,\"discount\":0}'"}]},{"operationId":"deleteEcommerceStoresIdOrdersIdLinesId","pathRoute":"/ecommerce-order-lines/delete-order-line-item","description":"Delete a specific order line item.","summary":"Delete order line item","endpoint":"/ecommerce/stores/{store_id}/orders/{order_id}/lines/{line_id}","verb":"delete","tags":["ecommerce"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.ecommerce.deleteOrderLineItem(\n    \"store_id\",\n    \"order_id\",\n    \"line_id\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->ecommerce->deleteOrderLineItem(\n    \"store_id\",\n    \"order_id\",\n    \"line_id\"\n);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.ecommerce.delete_order_line_item(\"store_id\", \"order_id\", \"line_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.ecommerce.delete_order_line_item('store_id', 'order_id', 'line_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X DELETE \\\n  https://${dc}.api.mailchimp.com/3.0/ecommerce/stores/{store_id}/orders/{order_id}/lines/{line_id} \\\n  --user \"anystring:${apikey}\"'"}]}],"sectionParent":{"sectionAnchor":"ecommerce-stores","sectionTitle":"E-commerce Stores"}},{"sectionTitle":"Orders","sectionAnchor":"ecommerce-orders","sectionDescription":"Orders represent successful e-commerce transactions, and this data can be used to provide more detailed campaign reports, track sales, and personalize emails to your targeted consumers, and view other e-commerce data in your Mailchimp account.","sectionRoute":"/ecommerce-orders","paths":[{"operationId":"getEcommerceOrders","pathRoute":"/ecommerce-orders/list-account-orders","description":"Get information about an account's orders.","summary":"List account orders","endpoint":"/ecommerce/orders","verb":"get","tags":["ecommerce"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.ecommerce.orders();\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->ecommerce->orders();\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.ecommerce.orders()\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.ecommerce.orders\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/ecommerce/orders?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>&count=10&offset=0&campaign_id=<SOME_STRING_VALUE>&outreach_id=<SOME_STRING_VALUE>&customer_id=<SOME_STRING_VALUE>&has_outreach=<SOME_BOOLEAN_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"getEcommerceStoresIdOrders","pathRoute":"/ecommerce-orders/list-orders","description":"Get information about a store's orders.","summary":"List orders","endpoint":"/ecommerce/stores/{store_id}/orders","verb":"get","tags":["ecommerce"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.ecommerce.getStoreOrders(\"store_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->ecommerce->getStoreOrders(\"store_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.ecommerce.get_store_orders(\"store_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.ecommerce.get_store_orders('store_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/ecommerce/stores/{store_id}/orders?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>&count=10&offset=0&customer_id=<SOME_STRING_VALUE>&has_outreach=<SOME_BOOLEAN_VALUE>&campaign_id=<SOME_STRING_VALUE>&outreach_id=<SOME_STRING_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"postEcommerceStoresIdOrders","pathRoute":"/ecommerce-orders/add-order","description":"Add a new order to a store.","summary":"Add order","endpoint":"/ecommerce/stores/{store_id}/orders","verb":"post","tags":["ecommerce"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.ecommerce.addStoreOrder(\"store_id\", {\n    id: \"id\",\n    customer: { id: \"id\" },\n    currency_code: \"currency_code\",\n    order_total: 3119,\n    lines: [\n      {\n        id: \"id\",\n        product_id: \"product_id\",\n        product_variant_id: \"product_variant_id\",\n        quantity: 68756,\n        price: 90682,\n      },\n    ],\n  });\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->ecommerce->addStoreOrder(\"store_id\", [\n    \"id\" => \"id\",\n    \"customer\" => [\"id\" => \"id\"],\n    \"currency_code\" => \"currency_code\",\n    \"order_total\" => 70717,\n    \"lines\" => [\n        [\n            \"id\" => \"id\",\n            \"product_id\" => \"product_id\",\n            \"product_variant_id\" => \"product_variant_id\",\n            \"quantity\" => 56067,\n            \"price\" => 41374,\n        ],\n    ],\n]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.ecommerce.add_store_order(\"store_id\", {\"id\": \"id\", \"customer\": {\"id\": \"id\"}, \"currency_code\": \"currency_code\", \"order_total\": 77884, \"lines\": [{\"id\": \"id\", \"product_id\": \"product_id\", \"product_variant_id\": \"product_variant_id\", \"quantity\": 75895, \"price\": 990}]})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.ecommerce.add_store_order(\n      'store_id',\n      {\n        'id' => 'id',\n        'customer' => { 'id' => 'id' },\n        'currency_code' => 'currency_code',\n        'order_total' => 43_106,\n        'lines' => [\n          {\n            'id' => 'id',\n            'product_id' => 'product_id',\n            'product_variant_id' => 'product_variant_id',\n            'quantity' => 34_127,\n            'price' => 8505\n          }\n        ]\n      }\n    )\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n  https://${dc}.api.mailchimp.com/3.0/ecommerce/stores/{store_id}/orders \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"id\":\"\",\"customer\":{\"id\":\"\",\"email_address\":\"\",\"opt_in_status\":false,\"company\":\"\",\"first_name\":\"\",\"last_name\":\"\",\"address\":{\"address1\":\"\",\"address2\":\"\",\"city\":\"\",\"province\":\"\",\"province_code\":\"\",\"postal_code\":\"\",\"country\":\"\",\"country_code\":\"\"}},\"campaign_id\":\"\",\"landing_site\":\"\",\"financial_status\":\"\",\"fulfillment_status\":\"\",\"currency_code\":\"\",\"order_total\":0,\"order_url\":\"\",\"discount_total\":0,\"tax_total\":0,\"shipping_total\":0,\"tracking_code\":\"prec\",\"processed_at_foreign\":\"\",\"cancelled_at_foreign\":\"\",\"updated_at_foreign\":\"\",\"shipping_address\":{\"name\":\"\",\"address1\":\"\",\"address2\":\"\",\"city\":\"\",\"province\":\"\",\"province_code\":\"\",\"postal_code\":\"\",\"country\":\"\",\"country_code\":\"\",\"longitude\":0,\"latitude\":0,\"phone\":\"\",\"company\":\"\"},\"billing_address\":{\"name\":\"\",\"address1\":\"\",\"address2\":\"\",\"city\":\"\",\"province\":\"\",\"province_code\":\"\",\"postal_code\":\"\",\"country\":\"\",\"country_code\":\"\",\"longitude\":0,\"latitude\":0,\"phone\":\"\",\"company\":\"\"},\"promos\":[],\"lines\":[],\"outreach\":{\"id\":\"\"},\"tracking_number\":\"\",\"tracking_carrier\":\"\",\"tracking_url\":\"\"}'"}]},{"operationId":"getEcommerceStoresIdOrdersId","pathRoute":"/ecommerce-orders/get-order-info","description":"Get information about a specific order.","summary":"Get order info","endpoint":"/ecommerce/stores/{store_id}/orders/{order_id}","verb":"get","tags":["ecommerce"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.ecommerce.getOrder(\"store_id\", \"order_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->ecommerce->getOrder(\"store_id\", \"order_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.ecommerce.get_order(\"store_id\", \"order_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.ecommerce.get_order('store_id', 'order_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/ecommerce/stores/{store_id}/orders/{order_id}?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"putEcommerceStoresIdOrdersId","pathRoute":"/ecommerce-orders/add-or-update-order","description":"Add or update an order.","summary":"Add or update order","endpoint":"/ecommerce/stores/{store_id}/orders/{order_id}","verb":"put","tags":["ecommerce"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.ecommerce.setOrder(\"store_id\", \"order_id\", {\n    id: \"id\",\n  });\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->ecommerce->setOrder(\"store_id\", \"order_id\", [\n    \"id\" => \"id\",\n]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.ecommerce.set_order(\"store_id\", \"order_id\", {\"id\": \"id\"})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.ecommerce.set_order('store_id', 'order_id', { 'id' => 'id' })\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X PUT \\\n  https://${dc}.api.mailchimp.com/3.0/ecommerce/stores/{store_id}/orders/{order_id} \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"id\":\"\",\"customer\":{\"id\":\"\",\"email_address\":\"\",\"opt_in_status\":false,\"company\":\"\",\"first_name\":\"\",\"last_name\":\"\",\"address\":{\"address1\":\"\",\"address2\":\"\",\"city\":\"\",\"province\":\"\",\"province_code\":\"\",\"postal_code\":\"\",\"country\":\"\",\"country_code\":\"\"}},\"campaign_id\":\"\",\"landing_site\":\"\",\"financial_status\":\"\",\"fulfillment_status\":\"\",\"currency_code\":\"\",\"order_total\":0,\"order_url\":\"\",\"discount_total\":0,\"tax_total\":0,\"shipping_total\":0,\"tracking_code\":\"prec\",\"processed_at_foreign\":\"\",\"cancelled_at_foreign\":\"\",\"updated_at_foreign\":\"\",\"shipping_address\":{\"name\":\"\",\"address1\":\"\",\"address2\":\"\",\"city\":\"\",\"province\":\"\",\"province_code\":\"\",\"postal_code\":\"\",\"country\":\"\",\"country_code\":\"\",\"longitude\":0,\"latitude\":0,\"phone\":\"\",\"company\":\"\"},\"billing_address\":{\"name\":\"\",\"address1\":\"\",\"address2\":\"\",\"city\":\"\",\"province\":\"\",\"province_code\":\"\",\"postal_code\":\"\",\"country\":\"\",\"country_code\":\"\",\"longitude\":0,\"latitude\":0,\"phone\":\"\",\"company\":\"\"},\"promos\":[],\"lines\":[],\"outreach\":{\"id\":\"\"},\"tracking_number\":\"\",\"tracking_carrier\":\"\",\"tracking_url\":\"\"}'"}]},{"operationId":"patchEcommerceStoresIdOrdersId","pathRoute":"/ecommerce-orders/update-order","description":"Update a specific order.","summary":"Update order","endpoint":"/ecommerce/stores/{store_id}/orders/{order_id}","verb":"patch","tags":["ecommerce"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.ecommerce.updateOrder(\n    \"store_id\",\n    \"order_id\",\n    {}\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->ecommerce->updateOrder(\"store_id\", \"order_id\", []);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.ecommerce.update_order(\"store_id\", \"order_id\", {})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.ecommerce.update_order('store_id', 'order_id', {})\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X PATCH \\\n  https://${dc}.api.mailchimp.com/3.0/ecommerce/stores/{store_id}/orders/{order_id} \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"customer\":{\"opt_in_status\":false,\"company\":\"\",\"first_name\":\"\",\"last_name\":\"\",\"address\":{\"address1\":\"\",\"address2\":\"\",\"city\":\"\",\"province\":\"\",\"province_code\":\"\",\"postal_code\":\"\",\"country\":\"\",\"country_code\":\"\"}},\"campaign_id\":\"\",\"landing_site\":\"\",\"financial_status\":\"\",\"fulfillment_status\":\"\",\"currency_code\":\"\",\"order_total\":0,\"order_url\":\"\",\"discount_total\":0,\"tax_total\":0,\"shipping_total\":0,\"tracking_code\":\"prec\",\"processed_at_foreign\":\"\",\"cancelled_at_foreign\":\"\",\"updated_at_foreign\":\"\",\"shipping_address\":{\"name\":\"\",\"address1\":\"\",\"address2\":\"\",\"city\":\"\",\"province\":\"\",\"province_code\":\"\",\"postal_code\":\"\",\"country\":\"\",\"country_code\":\"\",\"longitude\":0,\"latitude\":0,\"phone\":\"\",\"company\":\"\"},\"billing_address\":{\"name\":\"\",\"address1\":\"\",\"address2\":\"\",\"city\":\"\",\"province\":\"\",\"province_code\":\"\",\"postal_code\":\"\",\"country\":\"\",\"country_code\":\"\",\"longitude\":0,\"latitude\":0,\"phone\":\"\",\"company\":\"\"},\"promos\":[],\"lines\":[],\"outreach\":{\"id\":\"\"},\"tracking_number\":\"\",\"tracking_carrier\":\"\",\"tracking_url\":\"\"}'"}]},{"operationId":"deleteEcommerceStoresIdOrdersId","pathRoute":"/ecommerce-orders/delete-order","description":"Delete an order.","summary":"Delete order","endpoint":"/ecommerce/stores/{store_id}/orders/{order_id}","verb":"delete","tags":["ecommerce"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.ecommerce.deleteOrder(\"store_id\", \"order_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->ecommerce->deleteOrder(\"store_id\", \"order_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.ecommerce.delete_order(\"store_id\", \"order_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.ecommerce.delete_order('store_id', 'order_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X DELETE \\\n  https://${dc}.api.mailchimp.com/3.0/ecommerce/stores/{store_id}/orders/{order_id} \\\n  --user \"anystring:${apikey}\"'"}]}],"sectionParent":{"sectionAnchor":"ecommerce-stores","sectionTitle":"E-commerce Stores"}},{"sectionTitle":"Product Images","sectionAnchor":"ecommerce-product-images","sectionDescription":"A Product Image represents a specific product image.","sectionRoute":"/ecommerce-product-images","paths":[{"operationId":"getEcommerceStoresIdProductsIdImages","pathRoute":"/ecommerce-product-images/list-product-images","description":"Get information about a product's images.","summary":"List product images","endpoint":"/ecommerce/stores/{store_id}/products/{product_id}/images","verb":"get","tags":["ecommerce"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.ecommerce.getProductImages(\n    \"store_id\",\n    \"product_id\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->ecommerce->getProductImages(\"store_id\", \"product_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.ecommerce.get_product_images(\"store_id\", \"product_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.ecommerce.get_product_images('store_id', 'product_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/ecommerce/stores/{store_id}/products/{product_id}/images?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>&count=10&offset=0' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"postEcommerceStoresIdProductsIdImages","pathRoute":"/ecommerce-product-images/add-product-image","description":"Add a new image to the product.","summary":"Add product image","endpoint":"/ecommerce/stores/{store_id}/products/{product_id}/images","verb":"post","tags":["ecommerce"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.ecommerce.addProductImage(\n    \"store_id\",\n    \"product_id\",\n    { id: \"id\", url: \"https://ronny.info\" }\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->ecommerce->addProductImage(\"store_id\", \"product_id\", [\n    \"id\" => \"id\",\n    \"url\" => \"https://henry.info\",\n]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.ecommerce.add_product_image(\"store_id\", \"product_id\", {\"id\": \"id\", \"url\": \"https://amira.net\"})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.ecommerce.add_product_image(\n      'store_id',\n      'product_id',\n      { 'id' => 'id', 'url' => 'https://santina.net' }\n    )\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n  https://${dc}.api.mailchimp.com/3.0/ecommerce/stores/{store_id}/products/{product_id}/images \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"id\":\"\",\"url\":\"\",\"variant_ids\":[]}'"}]},{"operationId":"getEcommerceStoresIdProductsIdImagesId","pathRoute":"/ecommerce-product-images/get-product-image-info","description":"Get information about a specific product image.","summary":"Get product image info","endpoint":"/ecommerce/stores/{store_id}/products/{product_id}/images/{image_id}","verb":"get","tags":["ecommerce"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.ecommerce.getProductImage(\n    \"store_id\",\n    \"product_id\",\n    \"image_id\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->ecommerce->getProductImage(\n    \"store_id\",\n    \"product_id\",\n    \"image_id\"\n);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.ecommerce.get_product_image(\"store_id\", \"product_id\", \"image_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.ecommerce.get_product_image('store_id', 'product_id', 'image_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/ecommerce/stores/{store_id}/products/{product_id}/images/{image_id}?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"patchEcommerceStoresIdProductsIdImagesId","pathRoute":"/ecommerce-product-images/update-product-image","description":"Update a product image.","summary":"Update product image","endpoint":"/ecommerce/stores/{store_id}/products/{product_id}/images/{image_id}","verb":"patch","tags":["ecommerce"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.ecommerce.updateProductImage(\n    \"store_id\",\n    \"product_id\",\n    \"image_id\",\n    {}\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->ecommerce->updateProductImage(\n    \"store_id\",\n    \"product_id\",\n    \"image_id\",\n    []\n);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.ecommerce.update_product_image(\"store_id\", \"product_id\", \"image_id\", {})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.ecommerce.update_product_image(\n      'store_id',\n      'product_id',\n      'image_id',\n      {}\n    )\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X PATCH \\\n  https://${dc}.api.mailchimp.com/3.0/ecommerce/stores/{store_id}/products/{product_id}/images/{image_id} \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"id\":\"\",\"url\":\"\",\"variant_ids\":[]}'"}]},{"operationId":"deleteEcommerceStoresIdProductsIdImagesId","pathRoute":"/ecommerce-product-images/delete-product-image","description":"Delete a product image.","summary":"Delete product image","endpoint":"/ecommerce/stores/{store_id}/products/{product_id}/images/{image_id}","verb":"delete","tags":["ecommerce"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.ecommerce.deleteProductImage(\n    \"store_id\",\n    \"product_id\",\n    \"image_id\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->ecommerce->deleteProductImage(\n    \"store_id\",\n    \"product_id\",\n    \"image_id\"\n);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.ecommerce.delete_product_image(\"store_id\", \"product_id\", \"image_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.ecommerce.delete_product_image('store_id', 'product_id', 'image_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X DELETE \\\n  https://${dc}.api.mailchimp.com/3.0/ecommerce/stores/{store_id}/products/{product_id}/images/{image_id} \\\n  --user \"anystring:${apikey}\"'"}]}],"sectionParent":{"sectionAnchor":"ecommerce-stores","sectionTitle":"E-commerce Stores"}},{"sectionTitle":"Product Variants","sectionAnchor":"ecommerce-product-variants","sectionDescription":"A Product Variant represents a specific item for purchase, and is contained within a parent Product. At least one Product Variant is required for each Product.","sectionRoute":"/ecommerce-product-variants","paths":[{"operationId":"getEcommerceStoresIdProductsIdVariants","pathRoute":"/ecommerce-product-variants/list-product-variants","description":"Get information about a product's variants.","summary":"List product variants","endpoint":"/ecommerce/stores/{store_id}/products/{product_id}/variants","verb":"get","tags":["ecommerce"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.ecommerce.getProductVariants(\n    \"store_id\",\n    \"product_id\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->ecommerce->getProductVariants(\"store_id\", \"product_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.ecommerce.get_product_variants(\"store_id\", \"product_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.ecommerce.get_product_variants('store_id', 'product_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/ecommerce/stores/{store_id}/products/{product_id}/variants?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>&count=10&offset=0' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"postEcommerceStoresIdProductsIdVariants","pathRoute":"/ecommerce-product-variants/add-product-variant","description":"Add a new variant to the product.","summary":"Add product variant","endpoint":"/ecommerce/stores/{store_id}/products/{product_id}/variants","verb":"post","tags":["ecommerce"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.ecommerce.addProductVariants(\n    \"store_id\",\n    \"product_id\",\n    { id: \"id\", title: \"Cat Hat\" }\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->ecommerce->addProductVariants(\"store_id\", \"product_id\", [\n    \"id\" => \"id\",\n    \"title\" => \"Cat Hat\",\n]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.ecommerce.add_product_variants(\"store_id\", \"product_id\", {\"id\": \"id\", \"title\": \"Cat Hat\"})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.ecommerce.add_product_variants(\n      'store_id',\n      'product_id',\n      { 'id' => 'id', 'title' => 'Cat Hat' }\n    )\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n  https://${dc}.api.mailchimp.com/3.0/ecommerce/stores/{store_id}/products/{product_id}/variants \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"id\":\"\",\"title\":\"\",\"url\":\"\",\"sku\":\"\",\"price\":0,\"inventory_quantity\":0,\"image_url\":\"\",\"backorders\":\"\",\"visibility\":\"\"}'"}]},{"operationId":"getEcommerceStoresIdProductsIdVariantsId","pathRoute":"/ecommerce-product-variants/get-product-variant-info","description":"Get information about a specific product variant.","summary":"Get product variant info","endpoint":"/ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id}","verb":"get","tags":["ecommerce"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.ecommerce.getProductVariant(\n    \"store_id\",\n    \"product_id\",\n    \"variant_id\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->ecommerce->getProductVariant(\n    \"store_id\",\n    \"product_id\",\n    \"variant_id\"\n);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.ecommerce.get_product_variant(\"store_id\", \"product_id\", \"variant_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.ecommerce.get_product_variant('store_id', 'product_id', 'variant_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id}?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"putEcommerceStoresIdProductsIdVariantsId","pathRoute":"/ecommerce-product-variants/add-or-update-product-variant","description":"Add or update a product variant.","summary":"Add or update product variant","endpoint":"/ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id}","verb":"put","tags":["ecommerce"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.ecommerce.addProductVariant(\n    \"store_id\",\n    \"product_id\",\n    \"variant_id\",\n    { id: \"id\", title: \"Cat Hat\" }\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->ecommerce->addProductVariant(\n    \"store_id\",\n    \"product_id\",\n    \"variant_id\",\n    [\"id\" => \"id\", \"title\" => \"Cat Hat\"]\n);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.ecommerce.add_product_variant(\"store_id\", \"product_id\", \"variant_id\", {\"id\": \"id\", \"title\": \"Cat Hat\"})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.ecommerce.add_product_variant(\n      'store_id',\n      'product_id',\n      'variant_id',\n      { 'id' => 'id', 'title' => 'Cat Hat' }\n    )\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X PUT \\\n  https://${dc}.api.mailchimp.com/3.0/ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id} \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"id\":\"\",\"title\":\"\",\"url\":\"\",\"sku\":\"\",\"price\":0,\"inventory_quantity\":0,\"image_url\":\"\",\"backorders\":\"\",\"visibility\":\"\"}'"}]},{"operationId":"patchEcommerceStoresIdProductsIdVariantsId","pathRoute":"/ecommerce-product-variants/update-product-variant","description":"Update a product variant.","summary":"Update product variant","endpoint":"/ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id}","verb":"patch","tags":["ecommerce"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.ecommerce.updateProductVariant(\n    \"store_id\",\n    \"product_id\",\n    \"variant_id\",\n    {}\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->ecommerce->updateProductVariant(\n    \"store_id\",\n    \"product_id\",\n    \"variant_id\",\n    []\n);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.ecommerce.update_product_variant(\"store_id\", \"product_id\", \"variant_id\", {})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.ecommerce.update_product_variant(\n      'store_id',\n      'product_id',\n      'variant_id',\n      {}\n    )\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X PATCH \\\n  https://${dc}.api.mailchimp.com/3.0/ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id} \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"title\":\"\",\"url\":\"\",\"sku\":\"\",\"price\":0,\"inventory_quantity\":0,\"image_url\":\"\",\"backorders\":\"\",\"visibility\":\"\"}'"}]},{"operationId":"deleteEcommerceStoresIdProductsIdVariantsId","pathRoute":"/ecommerce-product-variants/delete-product-variant","description":"Delete a product variant.","summary":"Delete product variant","endpoint":"/ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id}","verb":"delete","tags":["ecommerce"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.ecommerce.deleteProductVariant(\n    \"store_id\",\n    \"product_id\",\n    \"variant_id\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->ecommerce->deleteProductVariant(\n    \"store_id\",\n    \"product_id\",\n    \"variant_id\"\n);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.ecommerce.delete_product_variant(\"store_id\", \"product_id\", \"variant_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.ecommerce.delete_product_variant(\n      'store_id',\n      'product_id',\n      'variant_id'\n    )\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X DELETE \\\n  https://${dc}.api.mailchimp.com/3.0/ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id} \\\n  --user \"anystring:${apikey}\"'"}]}],"sectionParent":{"sectionAnchor":"ecommerce-stores","sectionTitle":"E-commerce Stores"}},{"sectionTitle":"Products","sectionAnchor":"ecommerce-products","sectionDescription":"E-commerce items for sale in your store need to be created as Products so you can add the items to a Cart or an Order. Each Product requires at least one Product Variant.","sectionRoute":"/ecommerce-products","paths":[{"operationId":"getEcommerceStoresIdProducts","pathRoute":"/ecommerce-products/list-product","description":"Get information about a store's products.","summary":"List product","endpoint":"/ecommerce/stores/{store_id}/products","verb":"get","tags":["ecommerce"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.ecommerce.getAllStoreProducts(\"store_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->ecommerce->getAllStoreProducts(\"store_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.ecommerce.get_all_store_products(\"store_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.ecommerce.get_all_store_products('store_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/ecommerce/stores/{store_id}/products?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>&count=10&offset=0' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"postEcommerceStoresIdProducts","pathRoute":"/ecommerce-products/add-product","description":"Add a new product to a store.","summary":"Add product","endpoint":"/ecommerce/stores/{store_id}/products","verb":"post","tags":["ecommerce"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.ecommerce.addStoreProduct(\"store_id\", {\n    id: \"id\",\n    title: \"Cat Hat\",\n    variants: [{ id: \"id\", title: \"Cat Hat\" }],\n  });\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->ecommerce->addStoreProduct(\"store_id\", [\n    \"id\" => \"id\",\n    \"title\" => \"Cat Hat\",\n    \"variants\" => [[\"id\" => \"id\", \"title\" => \"Cat Hat\"]],\n]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.ecommerce.add_store_product(\"store_id\", {\"id\": \"id\", \"title\": \"Cat Hat\", \"variants\": [{\"id\": \"id\", \"title\": \"Cat Hat\"}]})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.ecommerce.add_store_product(\n      'store_id',\n      {\n        'id' => 'id',\n        'title' => 'Cat Hat',\n        'variants' => [{ 'id' => 'id', 'title' => 'Cat Hat' }]\n      }\n    )\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n  https://${dc}.api.mailchimp.com/3.0/ecommerce/stores/{store_id}/products \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"id\":\"\",\"title\":\"\",\"handle\":\"\",\"url\":\"\",\"description\":\"\",\"type\":\"\",\"vendor\":\"\",\"image_url\":\"\",\"variants\":[],\"images\":[],\"published_at_foreign\":\"\"}'"}]},{"operationId":"getEcommerceStoresIdProductsId","pathRoute":"/ecommerce-products/get-product-info","description":"Get information about a specific product.","summary":"Get product info","endpoint":"/ecommerce/stores/{store_id}/products/{product_id}","verb":"get","tags":["ecommerce"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.ecommerce.getStoreProduct(\n    \"store_id\",\n    \"product_id\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->ecommerce->getStoreProduct(\"store_id\", \"product_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.ecommerce.get_store_product(\"store_id\", \"product_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.ecommerce.get_store_product('store_id', 'product_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/ecommerce/stores/{store_id}/products/{product_id}?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"patchEcommerceStoresIdProductsId","pathRoute":"/ecommerce-products/update-product","description":"Update a specific product.","summary":"Update product","endpoint":"/ecommerce/stores/{store_id}/products/{product_id}","verb":"patch","tags":["ecommerce"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.ecommerce.updateStoreProduct(\n    \"store_id\",\n    \"product_id\",\n    {}\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->ecommerce->updateStoreProduct(\n    \"store_id\",\n    \"product_id\",\n    []\n);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.ecommerce.update_store_product(\"store_id\", \"product_id\", {})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.ecommerce.update_store_product('store_id', 'product_id', {})\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X PATCH \\\n  https://${dc}.api.mailchimp.com/3.0/ecommerce/stores/{store_id}/products/{product_id} \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"title\":\"\",\"handle\":\"\",\"url\":\"\",\"description\":\"\",\"type\":\"\",\"vendor\":\"\",\"image_url\":\"\",\"variants\":[],\"images\":[],\"published_at_foreign\":\"\"}'"}]},{"operationId":"putEcommerceStoresIdProductsId","pathRoute":"/ecommerce-products/create-or-update-product","description":"Update a specific product.","summary":"Create or update product","endpoint":"/ecommerce/stores/{store_id}/products/{product_id}","verb":"put","tags":["ecommerce"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.ecommerce.createOrUpdateStoreProduct(\n    \"store_id\",\n    \"product_id\",\n    { id: \"id\" }\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->ecommerce->createOrUpdateStoreProduct(\n    \"store_id\",\n    \"product_id\",\n    [\"id\" => \"id\"]\n);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.ecommerce.create_or_update_store_product(\"store_id\", \"product_id\", {\"id\": \"id\"})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.ecommerce.create_or_update_store_product(\n      'store_id',\n      'product_id',\n      { 'id' => 'id' }\n    )\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X PUT \\\n  https://${dc}.api.mailchimp.com/3.0/ecommerce/stores/{store_id}/products/{product_id} \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"id\":\"\",\"title\":\"\",\"handle\":\"\",\"url\":\"\",\"description\":\"\",\"type\":\"\",\"vendor\":\"\",\"image_url\":\"\",\"variants\":[],\"images\":[],\"published_at_foreign\":\"\"}'"}]},{"operationId":"deleteEcommerceStoresIdProductsId","pathRoute":"/ecommerce-products/delete-product","description":"Delete a product.","summary":"Delete product","endpoint":"/ecommerce/stores/{store_id}/products/{product_id}","verb":"delete","tags":["ecommerce"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.ecommerce.deleteStoreProduct(\n    \"store_id\",\n    \"product_id\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->ecommerce->deleteStoreProduct(\"store_id\", \"product_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.ecommerce.delete_store_product(\"store_id\", \"product_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.ecommerce.delete_store_product('store_id', 'product_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X DELETE \\\n  https://${dc}.api.mailchimp.com/3.0/ecommerce/stores/{store_id}/products/{product_id} \\\n  --user \"anystring:${apikey}\"'"}]}],"sectionParent":{"sectionAnchor":"ecommerce-stores","sectionTitle":"E-commerce Stores"}},{"sectionTitle":"Promo Codes","sectionAnchor":"ecommerce-promo-codes","sectionDescription":"Promo codes can be created for a given price rule. All the promo codes under a price rule share the generic information defined for that rule like the amount, type, expiration date etc. Promo code defines the more specific information about a promo code like the actual code, redemption_url, usage_count, etc that's unique to a code. Promo Code must be defined under a promo rule.","sectionRoute":"/ecommerce-promo-codes","paths":[{"operationId":"getEcommerceStoresIdPromocodes","pathRoute":"/ecommerce-promo-codes/list-promo-codes","description":"Get information about a store's promo codes.","summary":"List promo codes","endpoint":"/ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes","verb":"get","tags":["ecommerce"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.ecommerce.getPromoCodes(\n    \"promo_rule_id\",\n    \"store_id\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->ecommerce->getPromoCodes(\"promo_rule_id\", \"store_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.ecommerce.get_promo_codes(\"promo_rule_id\", \"store_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.ecommerce.get_promo_codes('promo_rule_id', 'store_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>&count=10&offset=0' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"postEcommerceStoresIdPromocodes","pathRoute":"/ecommerce-promo-codes/add-promo-code","description":"Add a new promo code to a store.","summary":"Add promo code","endpoint":"/ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes","verb":"post","tags":["ecommerce"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.ecommerce.addPromoCode(\n    \"store_id\",\n    \"promo_rule_id\",\n    {\n      id: \"id\",\n      code: \"summersale\",\n      redemption_url:\n        \"A url that applies promo code directly at checkout or a url that points to sale page or store url\",\n    }\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->ecommerce->addPromoCode(\"store_id\", \"promo_rule_id\", [\n    \"id\" => \"id\",\n    \"code\" => \"summersale\",\n    \"redemption_url\" =>\n        \"A url that applies promo code directly at checkout or a url that points to sale page or store url\",\n]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.ecommerce.add_promo_code(\"store_id\", \"promo_rule_id\", {\"id\": \"id\", \"code\": \"summersale\", \"redemption_url\": \"A url that applies promo code directly at checkout or a url that points to sale page or store url\"})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.ecommerce.add_promo_code(\n      'store_id',\n      'promo_rule_id',\n      {\n        'id' => 'id',\n        'code' => 'summersale',\n        'redemption_url' =>\n          'A url that applies promo code directly at checkout or a url that points to sale page or store url'\n      }\n    )\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n  https://${dc}.api.mailchimp.com/3.0/ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"id\":\"\",\"code\":\"\",\"redemption_url\":\"\",\"usage_count\":0,\"enabled\":false,\"created_at_foreign\":\"\",\"updated_at_foreign\":\"\"}'"}]},{"operationId":"getEcommerceStoresIdPromocodesId","pathRoute":"/ecommerce-promo-codes/get-promo-code","description":"Get information about a specific promo code.","summary":"Get promo code","endpoint":"/ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes/{promo_code_id}","verb":"get","tags":["ecommerce"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.ecommerce.getPromoCode(\n    \"store_id\",\n    \"promo_rule_id\",\n    \"promo_code_id\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->ecommerce->getPromoCode(\n    \"store_id\",\n    \"promo_rule_id\",\n    \"promo_code_id\"\n);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.ecommerce.get_promo_code(\"store_id\", \"promo_rule_id\", \"promo_code_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.ecommerce.get_promo_code(\n      'store_id',\n      'promo_rule_id',\n      'promo_code_id'\n    )\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes/{promo_code_id}?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"patchEcommerceStoresIdPromocodesId","pathRoute":"/ecommerce-promo-codes/update-promo-code","description":"Update a promo code.","summary":"Update promo code","endpoint":"/ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes/{promo_code_id}","verb":"patch","tags":["ecommerce"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.ecommerce.updatePromoCode(\n    \"store_id\",\n    \"promo_rule_id\",\n    \"promo_code_id\",\n    {}\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->ecommerce->updatePromoCode(\n    \"store_id\",\n    \"promo_rule_id\",\n    \"promo_code_id\",\n    []\n);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.ecommerce.update_promo_code(\"store_id\", \"promo_rule_id\", \"promo_code_id\", {})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.ecommerce.update_promo_code(\n      'store_id',\n      'promo_rule_id',\n      'promo_code_id',\n      {}\n    )\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X PATCH \\\n  https://${dc}.api.mailchimp.com/3.0/ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes/{promo_code_id} \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"code\":\"\",\"redemption_url\":\"\",\"usage_count\":0,\"enabled\":false,\"created_at_foreign\":\"\",\"updated_at_foreign\":\"\"}'"}]},{"operationId":"deleteEcommerceStoresIdPromocodesId","pathRoute":"/ecommerce-promo-codes/delete-promo-code","description":"Delete a promo code from a store.","summary":"Delete promo code","endpoint":"/ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes/{promo_code_id}","verb":"delete","tags":["ecommerce"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.ecommerce.deletePromoCode(\n    \"store_id\",\n    \"promo_rule_id\",\n    \"promo_code_id\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->ecommerce->deletePromoCode(\n    \"store_id\",\n    \"promo_rule_id\",\n    \"promo_code_id\"\n);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.ecommerce.delete_promo_code(\"store_id\", \"promo_rule_id\", \"promo_code_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.ecommerce.delete_promo_code(\n      'store_id',\n      'promo_rule_id',\n      'promo_code_id'\n    )\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X DELETE \\\n  https://${dc}.api.mailchimp.com/3.0/ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes/{promo_code_id} \\\n  --user \"anystring:${apikey}\"'"}]}],"sectionParent":{"sectionAnchor":"ecommerce-stores","sectionTitle":"E-commerce Stores"}},{"sectionTitle":"Promo Rules","sectionAnchor":"ecommerce-promo-rules","sectionDescription":"Promo Rules help you create promo codes for your campaigns. Promo Rules define generic information about promo codes like expiration time, start time, amount of discount being offered etc. For a given promo rule you can define if it's a percentage discount or a fixed amount and if it applies for the order as a whole or if it's per item or free shipping. You can then create promo codes for this price rule. Promo codes contain the actual code that is applied at checkout along with some other information. Price Rules have one to many relationship with promo codes.","sectionRoute":"/ecommerce-promo-rules","paths":[{"operationId":"getEcommerceStoresIdPromorules","pathRoute":"/ecommerce-promo-rules/list-promo-rules","description":"Get information about a store's promo rules.","summary":"List promo rules","endpoint":"/ecommerce/stores/{store_id}/promo-rules","verb":"get","tags":["ecommerce"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.ecommerce.listPromoRules(\"store_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->ecommerce->listPromoRules(\"store_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.ecommerce.list_promo_rules(\"store_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.ecommerce.list_promo_rules('store_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/ecommerce/stores/{store_id}/promo-rules?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>&count=10&offset=0' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"postEcommerceStoresIdPromorules","pathRoute":"/ecommerce-promo-rules/add-promo-rule","description":"Add a new promo rule to a store.","summary":"Add promo rule","endpoint":"/ecommerce/stores/{store_id}/promo-rules","verb":"post","tags":["ecommerce"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.ecommerce.addPromoRules(\"store_id\", {\n    id: \"id\",\n    description: \"Save BIG during our summer sale!\",\n    amount: 0.5,\n    type: \"percentage\",\n    target: \"total\",\n  });\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->ecommerce->addPromoRules(\"store_id\", [\n    \"id\" => \"id\",\n    \"description\" => \"Save BIG during our summer sale!\",\n    \"amount\" => 0.5,\n    \"type\" => \"fixed\",\n    \"target\" => \"shipping\",\n]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.ecommerce.add_promo_rules(\"store_id\", {\"id\": \"id\", \"description\": \"Save BIG during our summer sale!\", \"amount\": 0.5, \"type\": \"fixed\", \"target\": \"shipping\"})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.ecommerce.add_promo_rules(\n      'store_id',\n      {\n        'id' => 'id',\n        'description' => 'Save BIG during our summer sale!',\n        'amount' => 0.5,\n        'type' => 'percentage',\n        'target' => 'total'\n      }\n    )\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n  https://${dc}.api.mailchimp.com/3.0/ecommerce/stores/{store_id}/promo-rules \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"id\":\"\",\"title\":\"\",\"description\":\"\",\"starts_at\":\"\",\"ends_at\":\"\",\"amount\":0,\"type\":\"fixed\",\"target\":\"per_item\",\"enabled\":false,\"created_at_foreign\":\"\",\"updated_at_foreign\":\"\"}'"}]},{"operationId":"getEcommerceStoresIdPromorulesId","pathRoute":"/ecommerce-promo-rules/get-promo-rule","description":"Get information about a specific promo rule.","summary":"Get promo rule","endpoint":"/ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}","verb":"get","tags":["ecommerce"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.ecommerce.getPromoRule(\n    \"store_id\",\n    \"promo_rule_id\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->ecommerce->getPromoRule(\"store_id\", \"promo_rule_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.ecommerce.get_promo_rule(\"store_id\", \"promo_rule_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.ecommerce.get_promo_rule('store_id', 'promo_rule_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"patchEcommerceStoresIdPromorulesId","pathRoute":"/ecommerce-promo-rules/update-promo-rule","description":"Update a promo rule.","summary":"Update promo rule","endpoint":"/ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}","verb":"patch","tags":["ecommerce"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.ecommerce.updatePromoRule(\n    \"store_id\",\n    \"promo_rule_id\",\n    {}\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->ecommerce->updatePromoRule(\n    \"store_id\",\n    \"promo_rule_id\",\n    []\n);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.ecommerce.update_promo_rule(\"store_id\", \"promo_rule_id\", {})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.ecommerce.update_promo_rule('store_id', 'promo_rule_id', {})\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X PATCH \\\n  https://${dc}.api.mailchimp.com/3.0/ecommerce/stores/{store_id}/promo-rules/{promo_rule_id} \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"title\":\"\",\"description\":\"\",\"starts_at\":\"\",\"ends_at\":\"\",\"amount\":0,\"type\":\"fixed\",\"target\":\"per_item\",\"enabled\":false,\"created_at_foreign\":\"\",\"updated_at_foreign\":\"\"}'"}]},{"operationId":"deleteEcommerceStoresIdPromorulesId","pathRoute":"/ecommerce-promo-rules/delete-promo-rule","description":"Delete a promo rule from a store.","summary":"Delete promo rule","endpoint":"/ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}","verb":"delete","tags":["ecommerce"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.ecommerce.deletePromoRule(\n    \"store_id\",\n    \"promo_rule_id\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->ecommerce->deletePromoRule(\"store_id\", \"promo_rule_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.ecommerce.delete_promo_rule(\"store_id\", \"promo_rule_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.ecommerce.delete_promo_rule('store_id', 'promo_rule_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X DELETE \\\n  https://${dc}.api.mailchimp.com/3.0/ecommerce/stores/{store_id}/promo-rules/{promo_rule_id} \\\n  --user \"anystring:${apikey}\"'"}]}],"sectionParent":{"sectionAnchor":"ecommerce-stores","sectionTitle":"E-commerce Stores"}}]},{"sectionTitle":"Facebook Ads","sectionAnchor":"facebook-ads","sectionDescription":"Get information about Facebook Ads.","sectionRoute":"/facebook-ads","paths":[{"operationId":"getAllFacebookAds","pathRoute":"/facebook-ads/list-facebook-ads","description":"Get list of Facebook ads.","summary":"List facebook ads","endpoint":"/facebook-ads","verb":"get","tags":["facebookAds"],"deprecated":null,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.facebookAds.list();\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->facebookAds->list();\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.facebookAds.list()\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.facebookAds.list\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/facebook-ads?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>&count=10&offset=0&sort_field=<SOME_STRING_VALUE>&sort_dir=<SOME_STRING_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"getFacebookAdsId","pathRoute":"/facebook-ads/get-facebook-ad-info","description":"Get details of a Facebook ad.","summary":"Get facebook ad info","endpoint":"/facebook-ads/{outreach_id}","verb":"get","tags":["facebookAds"],"deprecated":null,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.facebookAds.getAd(\"outreach_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->facebookAds->getAd(\"outreach_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.facebookAds.get_ad(\"outreach_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.facebookAds.get_ad('outreach_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/facebook-ads/{outreach_id}?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]}],"subSections":[]},{"sectionTitle":"File Manager","sectionAnchor":"file-manager","sectionDescription":"Manage files for your Mailchimp account. The File Manager is a place to store images, documents, and other files you include or link to in your campaigns, templates, or signup forms.","sectionRoute":"/file-manager","paths":[],"subSections":[{"sectionTitle":"File Manager Files","sectionAnchor":"file-manager-files","sectionDescription":"Manage specific files in the File Manager for your Mailchimp account.","sectionRoute":"/file-manager-files","paths":[{"operationId":"getFileManagerFiles","pathRoute":"/file-manager-files/list-stored-files","description":"Get a list of available images and files stored in the File Manager for the account.","summary":"List stored files","endpoint":"/file-manager/files","verb":"get","tags":["fileManager"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.fileManager.files();\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->fileManager->files();\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.fileManager.files()\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.fileManager.files\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/file-manager/files?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>&count=10&offset=0&type=<SOME_STRING_VALUE>&created_by=<SOME_STRING_VALUE>&before_created_at=<SOME_STRING_VALUE>&since_created_at=<SOME_STRING_VALUE>&sort_field=<SOME_STRING_VALUE>&sort_dir=<SOME_STRING_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"postFileManagerFiles","pathRoute":"/file-manager-files/add-file","description":"Upload a new image or file to the File Manager.","summary":"Add file","endpoint":"/file-manager/files","verb":"post","tags":["fileManager"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.fileManager.upload({\n    name: \"name\",\n    file_data: \"file_data\",\n  });\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->fileManager->upload([\n    \"name\" => \"name\",\n    \"file_data\" => \"file_data\",\n]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.fileManager.upload({\"name\": \"name\", \"file_data\": \"file_data\"})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.fileManager.upload({ 'name' => 'name', 'file_data' => 'file_data' })\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n  https://${dc}.api.mailchimp.com/3.0/file-manager/files \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"folder_id\":0,\"name\":\"\",\"file_data\":\"\"}'"}]},{"operationId":"getFileManagerFilesId","pathRoute":"/file-manager-files/get-file","description":"Get information about a specific file in the File Manager.","summary":"Get file","endpoint":"/file-manager/files/{file_id}","verb":"get","tags":["fileManager"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.fileManager.getFile(\"file_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->fileManager->getFile(\"file_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.fileManager.get_file(\"file_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.fileManager.get_file('file_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/file-manager/files/{file_id}?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"patchFileManagerFilesId","pathRoute":"/file-manager-files/update-file","description":"Update a file in the File Manager.","summary":"Update file","endpoint":"/file-manager/files/{file_id}","verb":"patch","tags":["fileManager"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.fileManager.updateFile(\"file_id\", {});\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->fileManager->updateFile(\"file_id\", []);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.fileManager.update_file(\"file_id\", {})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.fileManager.update_file('file_id', {})\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X PATCH \\\n  https://${dc}.api.mailchimp.com/3.0/file-manager/files/{file_id} \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"folder_id\":0,\"name\":\"\"}'"}]},{"operationId":"deleteFileManagerFilesId","pathRoute":"/file-manager-files/delete-file","description":"Remove a specific file from the File Manager.","summary":"Delete file","endpoint":"/file-manager/files/{file_id}","verb":"delete","tags":["fileManager"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.fileManager.deleteFile(\"file_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->fileManager->deleteFile(\"file_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.fileManager.delete_file(\"file_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.fileManager.delete_file('file_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X DELETE \\\n  https://${dc}.api.mailchimp.com/3.0/file-manager/files/{file_id} \\\n  --user \"anystring:${apikey}\"'"}]}],"sectionParent":{"sectionAnchor":"file-manager","sectionTitle":"File Manager"}},{"sectionTitle":"File Manager Folders","sectionAnchor":"file-manager-folders","sectionDescription":"Manage specific folders in the File Manager for your Mailchimp account.","sectionRoute":"/file-manager-folders","paths":[{"operationId":"getFileManagerFolders","pathRoute":"/file-manager-folders/list-folders","description":"Get a list of all folders in the File Manager.","summary":"List folders","endpoint":"/file-manager/folders","verb":"get","tags":["fileManager"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.fileManager.listFolders();\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->fileManager->listFolders();\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.fileManager.list_folders()\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.fileManager.list_folders\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/file-manager/folders?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>&count=10&offset=0&created_by=<SOME_STRING_VALUE>&before_created_at=<SOME_STRING_VALUE>&since_created_at=<SOME_STRING_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"postFileManagerFolders","pathRoute":"/file-manager-folders/add-folder","description":"Create a new folder in the File Manager.","summary":"Add folder","endpoint":"/file-manager/folders","verb":"post","tags":["fileManager"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.fileManager.createFolder({ name: \"name\" });\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->fileManager->createFolder([\"name\" => \"name\"]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.fileManager.create_folder({\"name\": \"name\"})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.fileManager.create_folder({ 'name' => 'name' })\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n  https://${dc}.api.mailchimp.com/3.0/file-manager/folders \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"name\":\"\"}'"}]},{"operationId":"getFileManagerFoldersId","pathRoute":"/file-manager-folders/get-folder","description":"Get information about a specific folder in the File Manager.","summary":"Get folder","endpoint":"/file-manager/folders/{folder_id}","verb":"get","tags":["fileManager"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.fileManager.getFolder(\"folder_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->fileManager->getFolder(\"folder_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.fileManager.get_folder(\"folder_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.fileManager.get_folder('folder_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/file-manager/folders/{folder_id}?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"patchFileManagerFoldersId","pathRoute":"/file-manager-folders/update-folder","description":"Update a specific File Manager folder.","summary":"Update folder","endpoint":"/file-manager/folders/{folder_id}","verb":"patch","tags":["fileManager"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.fileManager.updateFolder(\"folder_id\", {\n    name: \"name\",\n  });\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->fileManager->updateFolder(\"folder_id\", [\"name\" => \"name\"]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.fileManager.update_folder(\"folder_id\", {\"name\": \"name\"})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.fileManager.update_folder('folder_id', { 'name' => 'name' })\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X PATCH \\\n  https://${dc}.api.mailchimp.com/3.0/file-manager/folders/{folder_id} \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"name\":\"\"}'"}]},{"operationId":"deleteFileManagerFoldersId","pathRoute":"/file-manager-folders/delete-folder","description":"Delete a specific folder in the File Manager.","summary":"Delete folder","endpoint":"/file-manager/folders/{folder_id}","verb":"delete","tags":["fileManager"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.fileManager.deleteFolder(\"folder_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->fileManager->deleteFolder(\"folder_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.fileManager.delete_folder(\"folder_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.fileManager.delete_folder('folder_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X DELETE \\\n  https://${dc}.api.mailchimp.com/3.0/file-manager/folders/{folder_id} \\\n  --user \"anystring:${apikey}\"'"}]}],"sectionParent":{"sectionAnchor":"file-manager","sectionTitle":"File Manager"}},{"sectionTitle":"Files in Folder","sectionAnchor":"file-manager-folders-files","sectionDescription":"Manage specific files in a folder.","sectionRoute":"/file-manager-folders-files","paths":[{"operationId":"getFileManagerFoldersFiles","pathRoute":"/file-manager-folders-files/list-stored-files","description":"Get a list of available images and files stored in this folder.","summary":"List stored files","endpoint":"/file-manager/folders/{folder_id}/files","verb":"get","tags":["fileManager"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.fileManager.foldersFiles(\"folder_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->fileManager->foldersFiles(\"folder_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.fileManager.folders_files(\"folder_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.fileManager.folders_files('folder_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/file-manager/folders/{folder_id}/files?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>&count=10&offset=0&type=<SOME_STRING_VALUE>&created_by=<SOME_STRING_VALUE>&before_created_at=<SOME_STRING_VALUE>&since_created_at=<SOME_STRING_VALUE>&sort_field=<SOME_STRING_VALUE>&sort_dir=<SOME_STRING_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]}],"sectionParent":{"sectionAnchor":"file-manager","sectionTitle":"File Manager"}}]},{"sectionTitle":"Landing Pages","sectionAnchor":"landing-pages","sectionDescription":"Manage your Landing Pages, including publishing and unpublishing.","sectionRoute":"/landing-pages","paths":[{"operationId":"getAllLandingPages","pathRoute":"/landing-pages/list-landing-pages","description":"Get all landing pages.","summary":"List landing pages","endpoint":"/landing-pages","verb":"get","tags":["landingPages"],"deprecated":null,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.landingPages.getAll();\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->landingPages->getAll();\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.landingPages.get_all()\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.landingPages.get_all\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/landing-pages?sort_dir=<SOME_STRING_VALUE>&sort_field=<SOME_STRING_VALUE>&fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>&count=10' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"postAllLandingPages","pathRoute":"/landing-pages/add-landing-page","description":"Create an unpublished and contentless Mailchimp landing page.","summary":"Add landing page","endpoint":"/landing-pages","verb":"post","tags":["landingPages"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.landingPages.create({});\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->landingPages->create([]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.landingPages.create({})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.landingPages.create({})\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n  'https://${dc}.api.mailchimp.com/3.0/landing-pages?use_default_list=<SOME_BOOLEAN_VALUE>' \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"name\":\"\",\"title\":\"\",\"description\":\"\",\"store_id\":\"\",\"list_id\":\"\",\"type\":\"signup\",\"template_id\":0,\"tracking\":{\"track_with_mailchimp\":false,\"enable_restricted_data_processing\":false}}'"}]},{"operationId":"getLandingPageId","pathRoute":"/landing-pages/get-landing-page-info","description":"Get information about a specific page.","summary":"Get landing page info","endpoint":"/landing-pages/{page_id}","verb":"get","tags":["landingPages"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.landingPages.getPage(\"page_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->landingPages->getPage(\"page_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.landingPages.get_page(\"page_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.landingPages.get_page('page_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/landing-pages/{page_id}?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"patchLandingPageId","pathRoute":"/landing-pages/update-landing-page","description":"Update a landing page.","summary":"Update landing page","endpoint":"/landing-pages/{page_id}","verb":"patch","tags":["landingPages"],"deprecated":null,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.landingPages.updatePage(\"page_id\", {});\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->landingPages->updatePage(\"page_id\", []);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.landingPages.update_page(\"page_id\", {})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.landingPages.update_page('page_id', {})\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X PATCH \\\n  https://${dc}.api.mailchimp.com/3.0/landing-pages/{page_id} \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"name\":\"\",\"title\":\"\",\"description\":\"\",\"store_id\":\"\",\"list_id\":\"\",\"tracking\":{\"track_with_mailchimp\":false,\"enable_restricted_data_processing\":false}}'"}]},{"operationId":"deleteLandingPageId","pathRoute":"/landing-pages/delete-landing-page","description":"Delete a landing page.","summary":"Delete landing page","endpoint":"/landing-pages/{page_id}","verb":"delete","tags":["landingPages"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.landingPages.deletePage(\"page_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->landingPages->deletePage(\"page_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.landingPages.delete_page(\"page_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.landingPages.delete_page('page_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X DELETE \\\n  https://${dc}.api.mailchimp.com/3.0/landing-pages/{page_id} \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"postLandingPageIdActionsPublish","pathRoute":"/landing-pages/publish-landing-page","description":"Publish a landing page that is in draft, unpublished, or has been previously published and edited.","summary":"Publish landing page","endpoint":"/landing-pages/{page_id}/actions/publish","verb":"post","tags":["landingPages"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.landingPages.publishPage(\"page_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->landingPages->publishPage(\"page_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.landingPages.publish_page(\"page_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.landingPages.publish_page('page_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n  https://${dc}.api.mailchimp.com/3.0/landing-pages/{page_id}/actions/publish \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"postLandingPageIdActionsUnpublish","pathRoute":"/landing-pages/unpublish-landing-page","description":"Unpublish a landing page that is in draft or has been published.","summary":"Unpublish landing page","endpoint":"/landing-pages/{page_id}/actions/unpublish","verb":"post","tags":["landingPages"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.landingPages.unpublishPage(\"page_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->landingPages->unpublishPage(\"page_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.landingPages.unpublish_page(\"page_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.landingPages.unpublish_page('page_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n  https://${dc}.api.mailchimp.com/3.0/landing-pages/{page_id}/actions/unpublish \\\n  --user \"anystring:${apikey}\"'"}]}],"subSections":[{"sectionTitle":"Content","sectionAnchor":"landing-pages-content","sectionDescription":"The HTML content for your Mailchimp landing pages.","sectionRoute":"/landing-pages-content","paths":[{"operationId":"getLandingPageIdContent","pathRoute":"/landing-pages-content/get-landing-page-content","description":"Get the the HTML for your landing page.","summary":"Get landing page content","endpoint":"/landing-pages/{page_id}/content","verb":"get","tags":["landingPages"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.landingPages.getPageContent(\"page_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->landingPages->getPageContent(\"page_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.landingPages.get_page_content(\"page_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.landingPages.get_page_content('page_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/landing-pages/{page_id}/content?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]}],"sectionParent":{"sectionAnchor":"landing-pages","sectionTitle":"Landing Pages"}}]},{"sectionTitle":"Lists/Audiences","sectionAnchor":"lists","sectionDescription":"Your Mailchimp list, also known as your audience, is where you store and manage all of your contacts.","sectionRoute":"/lists","paths":[{"operationId":"getLists","pathRoute":"/lists/get-lists-info","description":"Get information about all lists in the account.","summary":"Get lists info","endpoint":"/lists","verb":"get","tags":["lists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.lists.getAllLists();\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->lists->getAllLists();\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.lists.get_all_lists()\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.lists.get_all_lists\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/lists?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>&count=10&offset=0&before_date_created=<SOME_STRING_VALUE>&since_date_created=<SOME_STRING_VALUE>&before_campaign_last_sent=<SOME_STRING_VALUE>&since_campaign_last_sent=<SOME_STRING_VALUE>&email=<SOME_STRING_VALUE>&sort_field=<SOME_STRING_VALUE>&sort_dir=<SOME_STRING_VALUE>&has_ecommerce_store=<SOME_BOOLEAN_VALUE>&include_total_contacts=<SOME_BOOLEAN_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"postLists","pathRoute":"/lists/add-list","description":"Create a new list in your Mailchimp account.","summary":"Add list","endpoint":"/lists","verb":"post","tags":["lists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.lists.createList({\n    name: \"name\",\n    permission_reminder: \"permission_reminder\",\n    email_type_option: true,\n    contact: {\n      company: \"company\",\n      address1: \"address1\",\n      city: \"city\",\n      country: \"country\",\n    },\n    campaign_defaults: {\n      from_name: \"from_name\",\n      from_email: \"Mustafa.Rowe@gmail.com\",\n      subject: \"subject\",\n      language: \"language\",\n    },\n  });\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->lists->createList([\n    \"name\" => \"name\",\n    \"permission_reminder\" => \"permission_reminder\",\n    \"email_type_option\" => false,\n    \"contact\" => [\n        \"company\" => \"company\",\n        \"address1\" => \"address1\",\n        \"city\" => \"city\",\n        \"country\" => \"country\",\n    ],\n    \"campaign_defaults\" => [\n        \"from_name\" => \"from_name\",\n        \"from_email\" => \"Korbin59@yahoo.com\",\n        \"subject\" => \"subject\",\n        \"language\" => \"language\",\n    ],\n]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.lists.create_list({\"name\": \"name\", \"permission_reminder\": \"permission_reminder\", \"email_type_option\": true, \"contact\": {\"company\": \"company\", \"address1\": \"address1\", \"city\": \"city\", \"country\": \"country\"}, \"campaign_defaults\": {\"from_name\": \"from_name\", \"from_email\": \"Elmo30@gmail.com\", \"subject\": \"subject\", \"language\": \"language\"}})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.lists.create_list(\n      {\n        'name' => 'name',\n        'permission_reminder' => 'permission_reminder',\n        'email_type_option' => false,\n        'contact' => {\n          'company' => 'company',\n          'address1' => 'address1',\n          'city' => 'city',\n          'country' => 'country'\n        },\n        'campaign_defaults' => {\n          'from_name' => 'from_name',\n          'from_email' => 'Leann13@hotmail.com',\n          'subject' => 'subject',\n          'language' => 'language'\n        }\n      }\n    )\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n  https://${dc}.api.mailchimp.com/3.0/lists \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"name\":\"\",\"contact\":{\"company\":\"\",\"address1\":\"\",\"address2\":\"\",\"city\":\"\",\"state\":\"\",\"zip\":\"\",\"country\":\"\",\"phone\":\"\"},\"permission_reminder\":\"\",\"use_archive_bar\":false,\"campaign_defaults\":{\"from_name\":\"\",\"from_email\":\"\",\"subject\":\"\",\"language\":\"\"},\"notify_on_subscribe\":\"\",\"notify_on_unsubscribe\":\"\",\"email_type_option\":false,\"double_optin\":false,\"marketing_permissions\":false}'"}]},{"operationId":"getListsId","pathRoute":"/lists/get-list-info","description":"Get information about a specific list in your Mailchimp account. Results include list members who have signed up but haven't confirmed their subscription yet and unsubscribed or cleaned.","summary":"Get list info","endpoint":"/lists/{list_id}","verb":"get","tags":["lists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.lists.getList(\"list_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->lists->getList(\"list_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.lists.get_list(\"list_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.lists.get_list('list_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/lists/{list_id}?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>&include_total_contacts=<SOME_BOOLEAN_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"patchListsId","pathRoute":"/lists/update-lists","description":"Update the settings for a specific list.","summary":"Update lists","endpoint":"/lists/{list_id}","verb":"patch","tags":["lists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.lists.updateList(\"list_id\", {\n    name: \"name\",\n    permission_reminder: \"permission_reminder\",\n    email_type_option: false,\n    contact: {\n      company: \"company\",\n      address1: \"address1\",\n      city: \"city\",\n      state: \"state\",\n      zip: \"zip\",\n      country: \"country\",\n    },\n    campaign_defaults: {\n      from_name: \"from_name\",\n      from_email: \"Clemmie91@gmail.com\",\n      subject: \"subject\",\n      language: \"language\",\n    },\n  });\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->lists->updateList(\"list_id\", [\n    \"name\" => \"name\",\n    \"permission_reminder\" => \"permission_reminder\",\n    \"email_type_option\" => true,\n    \"contact\" => [\n        \"company\" => \"company\",\n        \"address1\" => \"address1\",\n        \"city\" => \"city\",\n        \"state\" => \"state\",\n        \"zip\" => \"zip\",\n        \"country\" => \"country\",\n    ],\n    \"campaign_defaults\" => [\n        \"from_name\" => \"from_name\",\n        \"from_email\" => \"Brando.Schoen@yahoo.com\",\n        \"subject\" => \"subject\",\n        \"language\" => \"language\",\n    ],\n]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.lists.update_list(\"list_id\", {\"name\": \"name\", \"permission_reminder\": \"permission_reminder\", \"email_type_option\": true, \"contact\": {\"company\": \"company\", \"address1\": \"address1\", \"city\": \"city\", \"state\": \"state\", \"zip\": \"zip\", \"country\": \"country\"}, \"campaign_defaults\": {\"from_name\": \"from_name\", \"from_email\": \"Idella73@yahoo.com\", \"subject\": \"subject\", \"language\": \"language\"}})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.lists.update_list(\n      'list_id',\n      {\n        'name' => 'name',\n        'permission_reminder' => 'permission_reminder',\n        'email_type_option' => true,\n        'contact' => {\n          'company' => 'company',\n          'address1' => 'address1',\n          'city' => 'city',\n          'state' => 'state',\n          'zip' => 'zip',\n          'country' => 'country'\n        },\n        'campaign_defaults' => {\n          'from_name' => 'from_name',\n          'from_email' => 'Aiden.Towne@hotmail.com',\n          'subject' => 'subject',\n          'language' => 'language'\n        }\n      }\n    )\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X PATCH \\\n  https://${dc}.api.mailchimp.com/3.0/lists/{list_id} \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"name\":\"\",\"contact\":{\"company\":\"\",\"address1\":\"\",\"address2\":\"\",\"city\":\"\",\"state\":\"\",\"zip\":\"\",\"country\":\"\",\"phone\":\"\"},\"permission_reminder\":\"\",\"use_archive_bar\":false,\"campaign_defaults\":{\"from_name\":\"\",\"from_email\":\"\",\"subject\":\"\",\"language\":\"\"},\"notify_on_subscribe\":\"\",\"notify_on_unsubscribe\":\"\",\"email_type_option\":false,\"double_optin\":false,\"marketing_permissions\":false}'"}]},{"operationId":"deleteListsId","pathRoute":"/lists/delete-list","description":"Delete a list from your Mailchimp account. If you delete a list, you'll lose the list history—including subscriber activity, unsubscribes, complaints, and bounces. You’ll also lose subscribers’ email addresses, unless you exported and backed up your list.","summary":"Delete list","endpoint":"/lists/{list_id}","verb":"delete","tags":["lists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.lists.deleteList(\"list_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->lists->deleteList(\"list_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.lists.delete_list(\"list_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.lists.delete_list('list_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X DELETE \\\n  https://${dc}.api.mailchimp.com/3.0/lists/{list_id} \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"postListsId","pathRoute":"/lists/batch-subscribe-or-unsubscribe","description":"Batch subscribe or unsubscribe list members.","summary":"Batch subscribe or unsubscribe","endpoint":"/lists/{list_id}","verb":"post","tags":["lists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.lists.batchListMembers(\"list_id\", {\n    members: [{}],\n  });\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->lists->batchListMembers(\"list_id\", [\"members\" => [[]]]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.lists.batch_list_members(\"list_id\", {\"members\": [{}]})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.lists.batch_list_members('list_id', { 'members' => [{}] })\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n  'https://${dc}.api.mailchimp.com/3.0/lists/{list_id}?skip_merge_validation=<SOME_BOOLEAN_VALUE>&skip_duplicate_check=<SOME_BOOLEAN_VALUE>' \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"members\":[],\"sync_tags\":false,\"update_existing\":false}'"}]}],"subSections":[{"sectionTitle":"Abuse Reports","sectionAnchor":"abuse-reports","sectionDescription":"Manage abuse complaints for a specific list. An abuse complaint occurs when your recipient reports an email as spam in their mail program.","sectionRoute":"/abuse-reports","paths":[{"operationId":"getListsIdAbuseReports","pathRoute":"/abuse-reports/list-abuse-reports","description":"Get all abuse reports for a specific list.","summary":"List abuse reports","endpoint":"/lists/{list_id}/abuse-reports","verb":"get","tags":["lists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.lists.getListAbuseReports(\"list_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->lists->getListAbuseReports(\"list_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.lists.get_list_abuse_reports(\"list_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.lists.get_list_abuse_reports('list_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/lists/{list_id}/abuse-reports?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>&count=10&offset=0' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"getListsIdAbuseReportsId","pathRoute":"/abuse-reports/get-abuse-report","description":"Get details about a specific abuse report.","summary":"Get abuse report","endpoint":"/lists/{list_id}/abuse-reports/{report_id}","verb":"get","tags":["lists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.lists.getListAbuseReportDetails(\n    \"list_id\",\n    \"report_id\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->lists->getListAbuseReportDetails(\"list_id\", \"report_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.lists.get_list_abuse_report_details(\"list_id\", \"report_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.lists.get_list_abuse_report_details('list_id', 'report_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/lists/{list_id}/abuse-reports/{report_id}?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>&count=10&offset=0' \\\n  --user \"anystring:${apikey}\"'"}]}],"sectionParent":{"sectionAnchor":"lists","sectionTitle":"Lists/Audiences"}},{"sectionTitle":"Activity","sectionAnchor":"list-activity","sectionDescription":"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.","sectionRoute":"/list-activity","paths":[{"operationId":"getListsIdActivity","pathRoute":"/list-activity/list-recent-activity","description":"Get up to the previous 180 days of daily detailed aggregated activity stats for a list, not including Automation activity.","summary":"List recent activity","endpoint":"/lists/{list_id}/activity","verb":"get","tags":["lists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.lists.getListRecentActivity(\"list_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->lists->getListRecentActivity(\"list_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.lists.get_list_recent_activity(\"list_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.lists.get_list_recent_activity('list_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/lists/{list_id}/activity?count=10&offset=0&fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]}],"sectionParent":{"sectionAnchor":"lists","sectionTitle":"Lists/Audiences"}},{"sectionTitle":"Clients","sectionAnchor":"list-clients","sectionDescription":"Get information about the most popular email clients for subscribers in a specific Mailchimp list.","sectionRoute":"/list-clients","paths":[{"operationId":"getListsIdClients","pathRoute":"/list-clients/list-top-email-clients","description":"Get a list of the top email clients based on user-agent strings.","summary":"List top email clients","endpoint":"/lists/{list_id}/clients","verb":"get","tags":["lists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.lists.getListClients(\"list_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->lists->getListClients(\"list_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.lists.get_list_clients(\"list_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.lists.get_list_clients('list_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/lists/{list_id}/clients?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]}],"sectionParent":{"sectionAnchor":"lists","sectionTitle":"Lists/Audiences"}},{"sectionTitle":"Events","sectionAnchor":"list-member-events","sectionDescription":"Use the Events endpoint to collect website or in-app actions and trigger targeted automations. ","sectionRoute":"/list-member-events","paths":[{"operationId":"getListsIdMembersIdEvents","pathRoute":"/list-member-events/list-member-events","description":"Get events for a contact.","summary":"List member events","endpoint":"/lists/{list_id}/members/{subscriber_hash}/events","verb":"get","tags":["lists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.lists.getListMemberEvents(\n    \"list_id\",\n    \"subscriber_hash\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->lists->getListMemberEvents(\"list_id\", \"subscriber_hash\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.lists.get_list_member_events(\"list_id\", \"subscriber_hash\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.lists.get_list_member_events('list_id', 'subscriber_hash')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/lists/{list_id}/members/{subscriber_hash}/events?count=10&offset=0&fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"postListMemberEvents","pathRoute":"/list-member-events/add-event","description":"Add an event for a list member.","summary":"Add event","endpoint":"/lists/{list_id}/members/{subscriber_hash}/events","verb":"post","tags":["lists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.lists.createListMemberEvent(\n    \"list_id\",\n    \"subscriber_hash\",\n    { name: \"name\" }\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->lists->createListMemberEvent(\n    \"list_id\",\n    \"subscriber_hash\",\n    [\"name\" => \"name\"]\n);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.lists.create_list_member_event(\"list_id\", \"subscriber_hash\", {\"name\": \"name\"})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.lists.create_list_member_event(\n      'list_id',\n      'subscriber_hash',\n      { 'name' => 'name' }\n    )\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n  https://${dc}.api.mailchimp.com/3.0/lists/{list_id}/members/{subscriber_hash}/events \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"name\":\"\",\"properties\":{},\"is_syncing\":false,\"occurred_at\":\"\"}'"}]}],"sectionParent":{"sectionAnchor":"lists","sectionTitle":"Lists/Audiences"}},{"sectionTitle":"Growth History","sectionAnchor":"list-growth-history","sectionDescription":"View a summary of the month-by-month growth activity for a specific list.","sectionRoute":"/list-growth-history","paths":[{"operationId":"getListsIdGrowthHistory","pathRoute":"/list-growth-history/list-growth-history-data","description":"Get a month-by-month summary of a specific list's growth activity.","summary":"List growth history data","endpoint":"/lists/{list_id}/growth-history","verb":"get","tags":["lists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.lists.getListGrowthHistory(\"list_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->lists->getListGrowthHistory(\"list_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.lists.get_list_growth_history(\"list_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.lists.get_list_growth_history('list_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/lists/{list_id}/growth-history?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>&count=10&offset=0&sort_field=<SOME_STRING_VALUE>&sort_dir=<SOME_STRING_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"getListsIdGrowthHistoryId","pathRoute":"/list-growth-history/get-growth-history-by-month","description":"Get a summary of a specific list's growth activity for a specific month and year.","summary":"Get growth history by month","endpoint":"/lists/{list_id}/growth-history/{month}","verb":"get","tags":["lists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.lists.getListGrowthHistoryByMonth(\n    \"list_id\",\n    \"month\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->lists->getListGrowthHistoryByMonth(\"list_id\", \"month\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.lists.get_list_growth_history_by_month(\"list_id\", \"month\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.lists.get_list_growth_history_by_month('list_id', 'month')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/lists/{list_id}/growth-history/{month}?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]}],"sectionParent":{"sectionAnchor":"lists","sectionTitle":"Lists/Audiences"}},{"sectionTitle":"Interest Categories","sectionAnchor":"interest-categories","sectionDescription":"Manage interest categories for a specific list. Interest categories organize interests, which are used to group subscribers based on their preferences. These correspond to 'group titles' in the Mailchimp application.","sectionRoute":"/interest-categories","paths":[{"operationId":"getListsIdInterestCategories","pathRoute":"/interest-categories/list-interest-categories","description":"Get information about a list's interest categories.","summary":"List interest categories","endpoint":"/lists/{list_id}/interest-categories","verb":"get","tags":["lists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.lists.getListInterestCategories(\"list_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->lists->getListInterestCategories(\"list_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.lists.get_list_interest_categories(\"list_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.lists.get_list_interest_categories('list_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/lists/{list_id}/interest-categories?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>&count=10&offset=0&type=<SOME_STRING_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"postListsIdInterestCategories","pathRoute":"/interest-categories/add-interest-category","description":"Create a new interest category.","summary":"Add interest category","endpoint":"/lists/{list_id}/interest-categories","verb":"post","tags":["lists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.lists.createListInterestCategory(\"list_id\", {\n    title: \"title\",\n    type: \"checkboxes\",\n  });\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->lists->createListInterestCategory(\"list_id\", [\n    \"title\" => \"title\",\n    \"type\" => \"hidden\",\n]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.lists.create_list_interest_category(\"list_id\", {\"title\": \"title\", \"type\": \"hidden\"})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.lists.create_list_interest_category(\n      'list_id',\n      { 'title' => 'title', 'type' => 'dropdown' }\n    )\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n  https://${dc}.api.mailchimp.com/3.0/lists/{list_id}/interest-categories \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"title\":\"\",\"display_order\":0,\"type\":\"checkboxes\"}'"}]},{"operationId":"getListsIdInterestCategoriesId","pathRoute":"/interest-categories/get-interest-category-info","description":"Get information about a specific interest category.","summary":"Get interest category info","endpoint":"/lists/{list_id}/interest-categories/{interest_category_id}","verb":"get","tags":["lists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.lists.getInterestCategory(\n    \"list_id\",\n    \"interest_category_id\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->lists->getInterestCategory(\n    \"list_id\",\n    \"interest_category_id\"\n);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.lists.get_interest_category(\"list_id\", \"interest_category_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.lists.get_interest_category('list_id', 'interest_category_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/lists/{list_id}/interest-categories/{interest_category_id}?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"patchListsIdInterestCategoriesId","pathRoute":"/interest-categories/update-interest-category","description":"Update a specific interest category.","summary":"Update interest category","endpoint":"/lists/{list_id}/interest-categories/{interest_category_id}","verb":"patch","tags":["lists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.lists.updateInterestCategory(\n    \"list_id\",\n    \"interest_category_id\",\n    { title: \"title\", type: \"checkboxes\" }\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->lists->updateInterestCategory(\n    \"list_id\",\n    \"interest_category_id\",\n    [\"title\" => \"title\", \"type\" => \"dropdown\"]\n);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.lists.update_interest_category(\"list_id\", \"interest_category_id\", {\"title\": \"title\", \"type\": \"dropdown\"})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.lists.update_interest_category(\n      'list_id',\n      'interest_category_id',\n      { 'title' => 'title', 'type' => 'hidden' }\n    )\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X PATCH \\\n  https://${dc}.api.mailchimp.com/3.0/lists/{list_id}/interest-categories/{interest_category_id} \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"title\":\"\",\"display_order\":0,\"type\":\"checkboxes\"}'"}]},{"operationId":"deleteListsIdInterestCategoriesId","pathRoute":"/interest-categories/delete-interest-category","description":"Delete a specific interest category.","summary":"Delete interest category","endpoint":"/lists/{list_id}/interest-categories/{interest_category_id}","verb":"delete","tags":["lists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.lists.deleteInterestCategory(\n    \"list_id\",\n    \"interest_category_id\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->lists->deleteInterestCategory(\n    \"list_id\",\n    \"interest_category_id\"\n);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.lists.delete_interest_category(\"list_id\", \"interest_category_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.lists.delete_interest_category('list_id', 'interest_category_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X DELETE \\\n  https://${dc}.api.mailchimp.com/3.0/lists/{list_id}/interest-categories/{interest_category_id} \\\n  --user \"anystring:${apikey}\"'"}]}],"sectionParent":{"sectionAnchor":"lists","sectionTitle":"Lists/Audiences"}},{"sectionTitle":"Interests","sectionAnchor":"interests","sectionDescription":"Manage interests for a specific Mailchimp list. Assign subscribers to interests to group them together. Interests are referred to as 'group names' in the Mailchimp application.","sectionRoute":"/interests","paths":[{"operationId":"getListsIdInterestCategoriesIdInterests","pathRoute":"/interests/list-interests-in-category","description":"Get a list of this category's interests.","summary":"List interests in category","endpoint":"/lists/{list_id}/interest-categories/{interest_category_id}/interests","verb":"get","tags":["lists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.lists.listInterestCategoryInterests(\n    \"list_id\",\n    \"interest_category_id\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->lists->listInterestCategoryInterests(\n    \"list_id\",\n    \"interest_category_id\"\n);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.lists.list_interest_category_interests(\"list_id\", \"interest_category_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.lists.list_interest_category_interests(\n      'list_id',\n      'interest_category_id'\n    )\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/lists/{list_id}/interest-categories/{interest_category_id}/interests?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>&count=10&offset=0' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"postListsIdInterestCategoriesIdInterests","pathRoute":"/interests/add-interest-in-category","description":"Create a new interest or 'group name' for a specific category.","summary":"Add interest in category","endpoint":"/lists/{list_id}/interest-categories/{interest_category_id}/interests","verb":"post","tags":["lists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.lists.createInterestCategoryInterest(\n    \"list_id\",\n    \"interest_category_id\",\n    { name: \"name\" }\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->lists->createInterestCategoryInterest(\n    \"list_id\",\n    \"interest_category_id\",\n    [\"name\" => \"name\"]\n);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.lists.create_interest_category_interest(\"list_id\", \"interest_category_id\", {\"name\": \"name\"})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.lists.create_interest_category_interest(\n      'list_id',\n      'interest_category_id',\n      { 'name' => 'name' }\n    )\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n  https://${dc}.api.mailchimp.com/3.0/lists/{list_id}/interest-categories/{interest_category_id}/interests \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"name\":\"\",\"display_order\":0}'"}]},{"operationId":"getListsIdInterestCategoriesIdInterestsId","pathRoute":"/interests/get-interest-in-category","description":"Get interests or 'group names' for a specific category.","summary":"Get interest in category","endpoint":"/lists/{list_id}/interest-categories/{interest_category_id}/interests/{interest_id}","verb":"get","tags":["lists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.lists.getInterestCategoryInterest(\n    \"list_id\",\n    \"interest_category_id\",\n    \"interest_id\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->lists->getInterestCategoryInterest(\n    \"list_id\",\n    \"interest_category_id\",\n    \"interest_id\"\n);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.lists.get_interest_category_interest(\"list_id\", \"interest_category_id\", \"interest_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.lists.get_interest_category_interest(\n      'list_id',\n      'interest_category_id',\n      'interest_id'\n    )\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/lists/{list_id}/interest-categories/{interest_category_id}/interests/{interest_id}?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"patchListsIdInterestCategoriesIdInterestsId","pathRoute":"/interests/update-interest-in-category","description":"Update interests or 'group names' for a specific category.","summary":"Update interest in category","endpoint":"/lists/{list_id}/interest-categories/{interest_category_id}/interests/{interest_id}","verb":"patch","tags":["lists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.lists.updateInterestCategoryInterest(\n    \"list_id\",\n    \"interest_category_id\",\n    \"interest_id\",\n    { name: \"name\" }\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->lists->updateInterestCategoryInterest(\n    \"list_id\",\n    \"interest_category_id\",\n    \"interest_id\",\n    [\"name\" => \"name\"]\n);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.lists.update_interest_category_interest(\"list_id\", \"interest_category_id\", \"interest_id\", {\"name\": \"name\"})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.lists.update_interest_category_interest(\n      'list_id',\n      'interest_category_id',\n      'interest_id',\n      { 'name' => 'name' }\n    )\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X PATCH \\\n  https://${dc}.api.mailchimp.com/3.0/lists/{list_id}/interest-categories/{interest_category_id}/interests/{interest_id} \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"name\":\"\",\"display_order\":0}'"}]},{"operationId":"deleteListsIdInterestCategoriesIdInterestsId","pathRoute":"/interests/delete-interest-in-category","description":"Delete interests or group names in a specific category.","summary":"Delete interest in category","endpoint":"/lists/{list_id}/interest-categories/{interest_category_id}/interests/{interest_id}","verb":"delete","tags":["lists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.lists.deleteInterestCategoryInterest(\n    \"list_id\",\n    \"interest_category_id\",\n    \"interest_id\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->lists->deleteInterestCategoryInterest(\n    \"list_id\",\n    \"interest_category_id\",\n    \"interest_id\"\n);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.lists.delete_interest_category_interest(\"list_id\", \"interest_category_id\", \"interest_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.lists.delete_interest_category_interest(\n      'list_id',\n      'interest_category_id',\n      'interest_id'\n    )\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X DELETE \\\n  https://${dc}.api.mailchimp.com/3.0/lists/{list_id}/interest-categories/{interest_category_id}/interests/{interest_id} \\\n  --user \"anystring:${apikey}\"'"}]}],"sectionParent":{"sectionAnchor":"lists","sectionTitle":"Lists/Audiences"}},{"sectionTitle":"Locations","sectionAnchor":"list-locations","sectionDescription":"Get the locations (countries) that the list's subscribers have been tagged to based on geocoding their IP address.","sectionRoute":"/list-locations","paths":[{"operationId":"getListsIdLocations","pathRoute":"/list-locations/list-locations","description":"Get the locations (countries) that the list's subscribers have been tagged to based on geocoding their IP address.","summary":"List locations","endpoint":"/lists/{list_id}/locations","verb":"get","tags":["lists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.lists.getListLocations(\"list_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->lists->getListLocations(\"list_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.lists.get_list_locations(\"list_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.lists.get_list_locations('list_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/lists/{list_id}/locations?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]}],"sectionParent":{"sectionAnchor":"lists","sectionTitle":"Lists/Audiences"}},{"sectionTitle":"Member Activity","sectionAnchor":"list-member-activity","sectionDescription":"Get details about a subscriber's recent activity. Use the new activity-feed endpoint to access more events for a given contact.","sectionRoute":"/list-member-activity","paths":[{"operationId":"getListsIdMembersIdActivity","pathRoute":"/list-member-activity/view-recent-activity-50","description":"Get the last 50 events of a member's activity on a specific list, including opens, clicks, and unsubscribes.","summary":"View recent activity 50","endpoint":"/lists/{list_id}/members/{subscriber_hash}/activity","verb":"get","tags":["lists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.lists.getListMemberActivity(\n    \"list_id\",\n    \"subscriber_hash\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->lists->getListMemberActivity(\"list_id\", \"subscriber_hash\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.lists.get_list_member_activity(\"list_id\", \"subscriber_hash\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.lists.get_list_member_activity('list_id', 'subscriber_hash')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/lists/{list_id}/members/{subscriber_hash}/activity?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>&action=<SOME_ARRAY_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]}],"sectionParent":{"sectionAnchor":"lists","sectionTitle":"Lists/Audiences"}},{"sectionTitle":"Member Activity Feed","sectionAnchor":"list-member-activity-feed","sectionDescription":"Get details about a subscriber's recent activity.","sectionRoute":"/list-member-activity-feed","paths":[{"operationId":"getListsIdMembersIdActivityFeed","pathRoute":"/list-member-activity-feed/view-recent-activity","description":"Get a member's activity on a specific list, including opens, clicks, and unsubscribes.","summary":"View recent activity","endpoint":"/lists/{list_id}/members/{subscriber_hash}/activity-feed","verb":"get","tags":["lists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.lists.getListMemberActivityFeed(\n    \"list_id\",\n    \"subscriber_hash\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->lists->getListMemberActivityFeed(\n    \"list_id\",\n    \"subscriber_hash\"\n);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.lists.get_list_member_activity_feed(\"list_id\", \"subscriber_hash\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.lists.get_list_member_activity_feed('list_id', 'subscriber_hash')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/lists/{list_id}/members/{subscriber_hash}/activity-feed?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>&count=10&offset=0&activity_filters=<SOME_ARRAY_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]}],"sectionParent":{"sectionAnchor":"lists","sectionTitle":"Lists/Audiences"}},{"sectionTitle":"Member Goals","sectionAnchor":"list-member-goal","sectionDescription":"Get information about recent goal events for a specific list member.","sectionRoute":"/list-member-goal","paths":[{"operationId":"getListsIdMembersIdGoals","pathRoute":"/list-member-goal/list-member-goal-events","description":"Get the last 50 Goal events for a member on a specific list.","summary":"List member goal events","endpoint":"/lists/{list_id}/members/{subscriber_hash}/goals","verb":"get","tags":["lists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.lists.getListMemberGoals(\n    \"list_id\",\n    \"subscriber_hash\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->lists->getListMemberGoals(\"list_id\", \"subscriber_hash\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.lists.getListMemberGoals(\"list_id\", \"subscriber_hash\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.lists.getListMemberGoals('list_id', 'subscriber_hash')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/lists/{list_id}/members/{subscriber_hash}/goals?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]}],"sectionParent":{"sectionAnchor":"lists","sectionTitle":"Lists/Audiences"}},{"sectionTitle":"Member Notes","sectionAnchor":"list-member-notes","sectionDescription":"Retrieve recent notes for a specific list member.","sectionRoute":"/list-member-notes","paths":[{"operationId":"getListsIdMembersIdNotes","pathRoute":"/list-member-notes/list-recent-member-notes","description":"Get recent notes for a specific list member.","summary":"List recent member notes","endpoint":"/lists/{list_id}/members/{subscriber_hash}/notes","verb":"get","tags":["lists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.lists.getListMemberNotes(\n    \"list_id\",\n    \"subscriber_hash\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->lists->getListMemberNotes(\"list_id\", \"subscriber_hash\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.lists.get_list_member_notes(\"list_id\", \"subscriber_hash\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.lists.get_list_member_notes('list_id', 'subscriber_hash')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/lists/{list_id}/members/{subscriber_hash}/notes?sort_field=<SOME_STRING_VALUE>&sort_dir=<SOME_STRING_VALUE>&fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>&count=10&offset=0' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"postListsIdMembersIdNotes","pathRoute":"/list-member-notes/add-member-note","description":"Add a new note for a specific subscriber.","summary":"Add member note","endpoint":"/lists/{list_id}/members/{subscriber_hash}/notes","verb":"post","tags":["lists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.lists.createListMemberNote(\n    \"list_id\",\n    \"subscriber_hash\",\n    {}\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->lists->createListMemberNote(\n    \"list_id\",\n    \"subscriber_hash\",\n    []\n);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.lists.create_list_member_note(\"list_id\", \"subscriber_hash\", {})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.lists.create_list_member_note('list_id', 'subscriber_hash', {})\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n  https://${dc}.api.mailchimp.com/3.0/lists/{list_id}/members/{subscriber_hash}/notes \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"note\":\"\"}'"}]},{"operationId":"getListsIdMembersIdNotesId","pathRoute":"/list-member-notes/get-member-note","description":"Get a specific note for a specific list member.","summary":"Get member note","endpoint":"/lists/{list_id}/members/{subscriber_hash}/notes/{note_id}","verb":"get","tags":["lists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.lists.getListMemberNote(\n    \"list_id\",\n    \"subscriber_hash\",\n    \"note_id\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->lists->getListMemberNote(\n    \"list_id\",\n    \"subscriber_hash\",\n    \"note_id\"\n);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.lists.get_list_member_note(\"list_id\", \"subscriber_hash\", \"note_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.lists.get_list_member_note('list_id', 'subscriber_hash', 'note_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/lists/{list_id}/members/{subscriber_hash}/notes/{note_id}?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"patchListsIdMembersIdNotesId","pathRoute":"/list-member-notes/update-note","description":"Update a specific note for a specific list member.","summary":"Update note","endpoint":"/lists/{list_id}/members/{subscriber_hash}/notes/{note_id}","verb":"patch","tags":["lists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.lists.updateListMemberNote(\n    \"list_id\",\n    \"subscriber_hash\",\n    \"note_id\",\n    {}\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->lists->updateListMemberNote(\n    \"list_id\",\n    \"subscriber_hash\",\n    \"note_id\",\n    []\n);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.lists.update_list_member_note(\"list_id\", \"subscriber_hash\", \"note_id\", {})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.lists.update_list_member_note(\n      'list_id',\n      'subscriber_hash',\n      'note_id',\n      {}\n    )\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X PATCH \\\n  https://${dc}.api.mailchimp.com/3.0/lists/{list_id}/members/{subscriber_hash}/notes/{note_id} \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"note\":\"\"}'"}]},{"operationId":"deleteListsIdMembersIdNotesId","pathRoute":"/list-member-notes/delete-note","description":"Delete a specific note for a specific list member.","summary":"Delete note","endpoint":"/lists/{list_id}/members/{subscriber_hash}/notes/{note_id}","verb":"delete","tags":["lists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.lists.deleteListMemberNote(\n    \"list_id\",\n    \"subscriber_hash\",\n    \"note_id\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->lists->deleteListMemberNote(\n    \"list_id\",\n    \"subscriber_hash\",\n    \"note_id\"\n);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.lists.delete_list_member_note(\"list_id\", \"subscriber_hash\", \"note_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.lists.delete_list_member_note(\n      'list_id',\n      'subscriber_hash',\n      'note_id'\n    )\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X DELETE \\\n  https://${dc}.api.mailchimp.com/3.0/lists/{list_id}/members/{subscriber_hash}/notes/{note_id} \\\n  --user \"anystring:${apikey}\"'"}]}],"sectionParent":{"sectionAnchor":"lists","sectionTitle":"Lists/Audiences"}},{"sectionTitle":"Member Tags","sectionAnchor":"list-member-tags","sectionDescription":"Manage all the tags that have been assigned to a contact.","sectionRoute":"/list-member-tags","paths":[{"operationId":"getListMemberTags","pathRoute":"/list-member-tags/list-member-tags","description":"Get the tags on a list member.","summary":"List member tags","endpoint":"/lists/{list_id}/members/{subscriber_hash}/tags","verb":"get","tags":["lists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.lists.getListMemberTags(\n    \"list_id\",\n    \"subscriber_hash\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->lists->getListMemberTags(\"list_id\", \"subscriber_hash\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.lists.get_list_member_tags(\"list_id\", \"subscriber_hash\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.lists.get_list_member_tags('list_id', 'subscriber_hash')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/lists/{list_id}/members/{subscriber_hash}/tags?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>&count=10&offset=0' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"postListMemberTags","pathRoute":"/list-member-tags/add-or-remove-member-tags","description":"Add or remove tags from a list member. If a tag that does not exist is passed in and set as 'active', a new tag will be created.","summary":"Add or remove member tags","endpoint":"/lists/{list_id}/members/{subscriber_hash}/tags","verb":"post","tags":["lists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.lists.updateListMemberTags(\n    \"list_id\",\n    \"subscriber_hash\",\n    { tags: [{ name: \"name\", status: \"inactive\" }] }\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->lists->updateListMemberTags(\"list_id\", \"subscriber_hash\", [\n    \"tags\" => [[\"name\" => \"name\", \"status\" => \"inactive\"]],\n]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.lists.update_list_member_tags(\"list_id\", \"subscriber_hash\", {\"tags\": [{\"name\": \"name\", \"status\": \"inactive\"}]})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.lists.update_list_member_tags(\n      'list_id',\n      'subscriber_hash',\n      { 'tags' => [{ 'name' => 'name', 'status' => 'active' }] }\n    )\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n  https://${dc}.api.mailchimp.com/3.0/lists/{list_id}/members/{subscriber_hash}/tags \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"tags\":[],\"is_syncing\":false}'"}]}],"sectionParent":{"sectionAnchor":"lists","sectionTitle":"Lists/Audiences"}},{"sectionTitle":"Members","sectionAnchor":"list-members","sectionDescription":"Manage members of a specific Mailchimp list, including currently subscribed, unsubscribed, and bounced members.","sectionRoute":"/list-members","paths":[{"operationId":"getListsIdMembers","pathRoute":"/list-members/list-members-info","description":"Get information about members in a specific Mailchimp list.","summary":"List members info","endpoint":"/lists/{list_id}/members","verb":"get","tags":["lists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.lists.getListMembersInfo(\"list_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->lists->getListMembersInfo(\"list_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.lists.get_list_members_info(\"list_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.lists.get_list_members_info('list_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/lists/{list_id}/members?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>&count=10&offset=0&email_type=<SOME_STRING_VALUE>&status=<SOME_STRING_VALUE>&since_timestamp_opt=<SOME_STRING_VALUE>&before_timestamp_opt=<SOME_STRING_VALUE>&since_last_changed=<SOME_STRING_VALUE>&before_last_changed=<SOME_STRING_VALUE>&unique_email_id=<SOME_STRING_VALUE>&vip_only=<SOME_BOOLEAN_VALUE>&interest_category_id=<SOME_STRING_VALUE>&interest_ids=<SOME_STRING_VALUE>&interest_match=<SOME_STRING_VALUE>&sort_field=<SOME_STRING_VALUE>&sort_dir=<SOME_STRING_VALUE>&since_last_campaign=<SOME_BOOLEAN_VALUE>&unsubscribed_since=<SOME_STRING_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"postListsIdMembers","pathRoute":"/list-members/add-member-to-list","description":"Add a new member to the list.","summary":"Add member to list","endpoint":"/lists/{list_id}/members","verb":"post","tags":["lists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.lists.addListMember(\"list_id\", {\n    email_address: \"Carmela83@gmail.com\",\n    status: \"unsubscribed\",\n  });\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->lists->addListMember(\"list_id\", [\n    \"email_address\" => \"Bernadine39@hotmail.com\",\n    \"status\" => \"unsubscribed\",\n]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.lists.add_list_member(\"list_id\", {\"email_address\": \"Angel.Schumm95@hotmail.com\", \"status\": \"pending\"})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.lists.add_list_member(\n      'list_id',\n      { 'email_address' => 'Patricia5@gmail.com', 'status' => 'transactional' }\n    )\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n  'https://${dc}.api.mailchimp.com/3.0/lists/{list_id}/members?skip_merge_validation=<SOME_BOOLEAN_VALUE>' \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"email_address\":\"\",\"email_type\":\"\",\"status\":\"subscribed\",\"merge_fields\":{},\"interests\":{},\"language\":\"\",\"vip\":false,\"location\":{\"latitude\":0,\"longitude\":0},\"marketing_permissions\":[],\"ip_signup\":\"\",\"timestamp_signup\":\"\",\"ip_opt\":\"\",\"timestamp_opt\":\"\",\"tags\":[]}'"}]},{"operationId":"getListsIdMembersId","pathRoute":"/list-members/get-member-info","description":"Get information about a specific list member, including a currently subscribed, unsubscribed, or bounced member.","summary":"Get member info","endpoint":"/lists/{list_id}/members/{subscriber_hash}","verb":"get","tags":["lists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.lists.getListMember(\n    \"list_id\",\n    \"subscriber_hash\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->lists->getListMember(\"list_id\", \"subscriber_hash\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.lists.get_list_member(\"list_id\", \"subscriber_hash\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.lists.get_list_member('list_id', 'subscriber_hash')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/lists/{list_id}/members/{subscriber_hash}?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"putListsIdMembersId","pathRoute":"/list-members/add-or-update-list-member","description":"Add or update a list member.","summary":"Add or update list member","endpoint":"/lists/{list_id}/members/{subscriber_hash}","verb":"put","tags":["lists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.lists.setListMember(\n    \"list_id\",\n    \"subscriber_hash\",\n    { email_address: \"Trinity93@hotmail.com\", status_if_new: \"pending\" }\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->lists->setListMember(\"list_id\", \"subscriber_hash\", [\n    \"email_address\" => \"Kacie90@hotmail.com\",\n    \"status_if_new\" => \"transactional\",\n]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.lists.set_list_member(\"list_id\", \"subscriber_hash\", {\"email_address\": \"Shayne84@hotmail.com\", \"status_if_new\": \"unsubscribed\"})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.lists.set_list_member(\n      'list_id',\n      'subscriber_hash',\n      {\n        'email_address' => 'Furman_Purdy78@gmail.com',\n        'status_if_new' => 'unsubscribed'\n      }\n    )\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X PUT \\\n  'https://${dc}.api.mailchimp.com/3.0/lists/{list_id}/members/{subscriber_hash}?skip_merge_validation=<SOME_BOOLEAN_VALUE>' \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"email_address\":\"\",\"status_if_new\":\"subscribed\",\"email_type\":\"\",\"status\":\"subscribed\",\"merge_fields\":{},\"interests\":{},\"language\":\"\",\"vip\":false,\"location\":{\"latitude\":0,\"longitude\":0},\"marketing_permissions\":[],\"ip_signup\":\"\",\"timestamp_signup\":\"\",\"ip_opt\":\"\",\"timestamp_opt\":\"\"}'"}]},{"operationId":"patchListsIdMembersId","pathRoute":"/list-members/update-list-member","description":"Update information for a specific list member.","summary":"Update list member","endpoint":"/lists/{list_id}/members/{subscriber_hash}","verb":"patch","tags":["lists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.lists.updateListMember(\n    \"list_id\",\n    \"subscriber_hash\",\n    {}\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->lists->updateListMember(\"list_id\", \"subscriber_hash\", []);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.lists.update_list_member(\"list_id\", \"subscriber_hash\", {})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.lists.update_list_member('list_id', 'subscriber_hash', {})\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X PATCH \\\n  'https://${dc}.api.mailchimp.com/3.0/lists/{list_id}/members/{subscriber_hash}?skip_merge_validation=<SOME_BOOLEAN_VALUE>' \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"email_address\":\"\",\"email_type\":\"\",\"status\":\"subscribed\",\"merge_fields\":{},\"interests\":{},\"language\":\"\",\"vip\":false,\"location\":{\"latitude\":0,\"longitude\":0},\"marketing_permissions\":[],\"ip_signup\":\"\",\"timestamp_signup\":\"\",\"ip_opt\":\"\",\"timestamp_opt\":\"\"}'"}]},{"operationId":"deleteListsIdMembersId","pathRoute":"/list-members/archive-list-member","description":"Archive a list member. To permanently delete, use the delete-permanent action.","summary":"Archive list member","endpoint":"/lists/{list_id}/members/{subscriber_hash}","verb":"delete","tags":["lists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.lists.deleteListMember(\n    \"list_id\",\n    \"subscriber_hash\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->lists->deleteListMember(\"list_id\", \"subscriber_hash\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.lists.delete_list_member(\"list_id\", \"subscriber_hash\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.lists.delete_list_member('list_id', 'subscriber_hash')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X DELETE \\\n  https://${dc}.api.mailchimp.com/3.0/lists/{list_id}/members/{subscriber_hash} \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"postListsIdMembersHashActionsDeletePermanent","pathRoute":"/list-members/delete-list-member","description":"Delete all personally identifiable information related to a list member, and remove them from a list. This will make it impossible to re-import the list member.","summary":"Delete list member","endpoint":"/lists/{list_id}/members/{subscriber_hash}/actions/delete-permanent","verb":"post","tags":["lists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.lists.deleteListMemberPermanent(\n    \"list_id\",\n    \"subscriber_hash\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->lists->deleteListMemberPermanent(\n    \"list_id\",\n    \"subscriber_hash\"\n);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.lists.delete_list_member_permanent(\"list_id\", \"subscriber_hash\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.lists.delete_list_member_permanent('list_id', 'subscriber_hash')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n  https://${dc}.api.mailchimp.com/3.0/lists/{list_id}/members/{subscriber_hash}/actions/delete-permanent \\\n  --user \"anystring:${apikey}\"'"}]}],"sectionParent":{"sectionAnchor":"lists","sectionTitle":"Lists/Audiences"}},{"sectionTitle":"Merge Fields","sectionAnchor":"list-merges","sectionDescription":"Manage merge fields for an audience. See [Merge Field documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/) for more.","sectionRoute":"/list-merges","paths":[{"operationId":"getListsIdMergeFields","pathRoute":"/list-merges/list-merge-fields","description":"Get a list of all merge fields for an audience.","summary":"List merge fields","endpoint":"/lists/{list_id}/merge-fields","verb":"get","tags":["lists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.lists.getListMergeFields(\"list_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->lists->getListMergeFields(\"list_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.lists.get_list_merge_fields(\"list_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.lists.get_list_merge_fields('list_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/lists/{list_id}/merge-fields?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>&count=10&offset=0&type=<SOME_STRING_VALUE>&required=<SOME_BOOLEAN_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"postListsIdMergeFields","pathRoute":"/list-merges/add-merge-field","description":"Add a new merge field for a specific audience.","summary":"Add merge field","endpoint":"/lists/{list_id}/merge-fields","verb":"post","tags":["lists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.lists.addListMergeField(\"list_id\", {\n    name: \"name\",\n    type: \"zip\",\n  });\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->lists->addListMergeField(\"list_id\", [\n    \"name\" => \"name\",\n    \"type\" => \"address\",\n]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.lists.add_list_merge_field(\"list_id\", {\"name\": \"name\", \"type\": \"url\"})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.lists.add_list_merge_field(\n      'list_id',\n      { 'name' => 'name', 'type' => 'zip' }\n    )\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n  https://${dc}.api.mailchimp.com/3.0/lists/{list_id}/merge-fields \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"tag\":\"\",\"name\":\"\",\"type\":\"text\",\"required\":false,\"default_value\":\"\",\"public\":false,\"display_order\":0,\"options\":{\"default_country\":0,\"phone_format\":\"\",\"date_format\":\"\",\"choices\":[],\"size\":0},\"help_text\":\"\"}'"}]},{"operationId":"getListsIdMergeFieldsId","pathRoute":"/list-merges/get-merge-field","description":"Get information about a specific merge field.","summary":"Get merge field","endpoint":"/lists/{list_id}/merge-fields/{merge_id}","verb":"get","tags":["lists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.lists.getListMergeField(\"list_id\", \"merge_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->lists->getListMergeField(\"list_id\", \"merge_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.lists.get_list_merge_field(\"list_id\", \"merge_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.lists.get_list_merge_field('list_id', 'merge_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/lists/{list_id}/merge-fields/{merge_id}?exclude_fields=<SOME_ARRAY_VALUE>&fields=<SOME_ARRAY_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"patchListsIdMergeFieldsId","pathRoute":"/list-merges/update-merge-field","description":"Update a specific merge field.","summary":"Update merge field","endpoint":"/lists/{list_id}/merge-fields/{merge_id}","verb":"patch","tags":["lists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.lists.updateListMergeField(\n    \"list_id\",\n    \"merge_id\",\n    { name: \"name\" }\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->lists->updateListMergeField(\"list_id\", \"merge_id\", [\n    \"name\" => \"name\",\n]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.lists.update_list_merge_field(\"list_id\", \"merge_id\", {\"name\": \"name\"})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.lists.update_list_merge_field(\n      'list_id',\n      'merge_id',\n      { 'name' => 'name' }\n    )\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X PATCH \\\n  https://${dc}.api.mailchimp.com/3.0/lists/{list_id}/merge-fields/{merge_id} \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"tag\":\"\",\"name\":\"\",\"required\":false,\"default_value\":\"\",\"public\":false,\"display_order\":0,\"options\":{\"default_country\":0,\"phone_format\":\"\",\"date_format\":\"\",\"choices\":[]},\"help_text\":\"\"}'"}]},{"operationId":"deleteListsIdMergeFieldsId","pathRoute":"/list-merges/delete-merge-field","description":"Delete a specific merge field.","summary":"Delete merge field","endpoint":"/lists/{list_id}/merge-fields/{merge_id}","verb":"delete","tags":["lists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.lists.deleteListMergeField(\n    \"list_id\",\n    \"merge_id\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->lists->deleteListMergeField(\"list_id\", \"merge_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.lists.delete_list_merge_field(\"list_id\", \"merge_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.lists.delete_list_merge_field('list_id', 'merge_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X DELETE \\\n  https://${dc}.api.mailchimp.com/3.0/lists/{list_id}/merge-fields/{merge_id} \\\n  --user \"anystring:${apikey}\"'"}]}],"sectionParent":{"sectionAnchor":"lists","sectionTitle":"Lists/Audiences"}},{"sectionTitle":"Segment Members","sectionAnchor":"list-segment-members","sectionDescription":"Manage list members in a saved segment.","sectionRoute":"/list-segment-members","paths":[{"operationId":"getListsIdSegmentsIdMembers","pathRoute":"/list-segment-members/list-members-in-segment","description":"Get information about members in a saved segment.","summary":"List members in segment","endpoint":"/lists/{list_id}/segments/{segment_id}/members","verb":"get","tags":["lists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.lists.getSegmentMembersList(\n    \"list_id\",\n    \"segment_id\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->lists->getSegmentMembersList(\"list_id\", \"segment_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.lists.get_segment_members_list(\"list_id\", \"segment_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.lists.get_segment_members_list('list_id', 'segment_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/lists/{list_id}/segments/{segment_id}/members?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>&count=10&offset=0&include_cleaned=<SOME_BOOLEAN_VALUE>&include_transactional=<SOME_BOOLEAN_VALUE>&include_unsubscribed=<SOME_BOOLEAN_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"postListsIdSegmentsIdMembers","pathRoute":"/list-segment-members/add-member-to-segment","description":"Add a member to a static segment.","summary":"Add member to segment","endpoint":"/lists/{list_id}/segments/{segment_id}/members","verb":"post","tags":["lists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.lists.createSegmentMember(\n    \"list_id\",\n    \"segment_id\",\n    { email_address: \"Ronny_Wilderman22@gmail.com\" }\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->lists->createSegmentMember(\"list_id\", \"segment_id\", [\n    \"email_address\" => \"Asia6@hotmail.com\",\n]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.lists.create_segment_member(\"list_id\", \"segment_id\", {\"email_address\": \"Hailee85@gmail.com\"})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.lists.create_segment_member(\n      'list_id',\n      'segment_id',\n      { 'email_address' => 'Nettie68@gmail.com' }\n    )\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n  https://${dc}.api.mailchimp.com/3.0/lists/{list_id}/segments/{segment_id}/members \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"email_address\":\"\"}'"}]},{"operationId":"deleteListsIdSegmentsIdMembersId","pathRoute":"/list-segment-members/remove-list-member-from-segment","description":"Remove a member from the specified static segment.","summary":"Remove list member from segment","endpoint":"/lists/{list_id}/segments/{segment_id}/members/{subscriber_hash}","verb":"delete","tags":["lists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.lists.removeSegmentMember(\n    \"list_id\",\n    \"segment_id\",\n    \"subscriber_hash\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->lists->removeSegmentMember(\n    \"list_id\",\n    \"segment_id\",\n    \"subscriber_hash\"\n);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.lists.remove_segment_member(\"list_id\", \"segment_id\", \"subscriber_hash\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.lists.remove_segment_member(\n      'list_id',\n      'segment_id',\n      'subscriber_hash'\n    )\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X DELETE \\\n  https://${dc}.api.mailchimp.com/3.0/lists/{list_id}/segments/{segment_id}/members/{subscriber_hash} \\\n  --user \"anystring:${apikey}\"'"}]}],"sectionParent":{"sectionAnchor":"lists","sectionTitle":"Lists/Audiences"}},{"sectionTitle":"Segments","sectionAnchor":"list-segments","sectionDescription":"Manage segments and tags for a specific Mailchimp list. A segment is a section of your list that includes only those subscribers who share specific common field information. Tags are labels you create to help organize your contacts.","sectionRoute":"/list-segments","paths":[{"operationId":"previewASegment","pathRoute":"/list-segments/list-segments","description":"Get information about all available segments for a specific list.","summary":"List segments","endpoint":"/lists/{list_id}/segments","verb":"get","tags":["lists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.lists.listSegments(\"list_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->lists->listSegments(\"list_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.lists.list_segments(\"list_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.lists.list_segments('list_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/lists/{list_id}/segments?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>&count=10&offset=0&type=<SOME_STRING_VALUE>&since_created_at=<SOME_STRING_VALUE>&before_created_at=<SOME_STRING_VALUE>&include_cleaned=<SOME_BOOLEAN_VALUE>&include_transactional=<SOME_BOOLEAN_VALUE>&include_unsubscribed=<SOME_BOOLEAN_VALUE>&since_updated_at=<SOME_STRING_VALUE>&before_updated_at=<SOME_STRING_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"postListsIdSegments","pathRoute":"/list-segments/add-segment","description":"Create a new segment in a specific list.","summary":"Add segment","endpoint":"/lists/{list_id}/segments","verb":"post","tags":["lists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.lists.createSegment(\"list_id\", {\n    name: \"name\",\n  });\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->lists->createSegment(\"list_id\", [\"name\" => \"name\"]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.lists.create_segment(\"list_id\", {\"name\": \"name\"})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.lists.create_segment('list_id', { 'name' => 'name' })\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n  https://${dc}.api.mailchimp.com/3.0/lists/{list_id}/segments \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"name\":\"\",\"static_segment\":[],\"options\":{\"match\":\"any\",\"conditions\":[]}}'"}]},{"operationId":"getListsIdSegmentsId","pathRoute":"/list-segments/get-segment-info","description":"Get information about a specific segment.","summary":"Get segment info","endpoint":"/lists/{list_id}/segments/{segment_id}","verb":"get","tags":["lists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.lists.getSegment(\"list_id\", \"segment_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->lists->getSegment(\"list_id\", \"segment_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.lists.get_segment(\"list_id\", \"segment_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.lists.get_segment('list_id', 'segment_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/lists/{list_id}/segments/{segment_id}?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>&include_cleaned=<SOME_BOOLEAN_VALUE>&include_transactional=<SOME_BOOLEAN_VALUE>&include_unsubscribed=<SOME_BOOLEAN_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"deleteListsIdSegmentsId","pathRoute":"/list-segments/delete-segment","description":"Delete a specific segment in a list.","summary":"Delete segment","endpoint":"/lists/{list_id}/segments/{segment_id}","verb":"delete","tags":["lists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.lists.deleteSegment(\"list_id\", \"segment_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->lists->deleteSegment(\"list_id\", \"segment_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.lists.delete_segment(\"list_id\", \"segment_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.lists.delete_segment('list_id', 'segment_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X DELETE \\\n  https://${dc}.api.mailchimp.com/3.0/lists/{list_id}/segments/{segment_id} \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"patchListsIdSegmentsId","pathRoute":"/list-segments/update-segment","description":"Update a specific segment in a list.","summary":"Update segment","endpoint":"/lists/{list_id}/segments/{segment_id}","verb":"patch","tags":["lists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.lists.updateSegment(\"list_id\", \"segment_id\", {\n    name: \"name\",\n  });\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->lists->updateSegment(\"list_id\", \"segment_id\", [\n    \"name\" => \"name\",\n]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.lists.update_segment(\"list_id\", \"segment_id\", {\"name\": \"name\"})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.lists.update_segment('list_id', 'segment_id', { 'name' => 'name' })\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X PATCH \\\n  https://${dc}.api.mailchimp.com/3.0/lists/{list_id}/segments/{segment_id} \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"name\":\"\",\"static_segment\":[],\"options\":{\"match\":\"any\",\"conditions\":[]}}'"}]},{"operationId":"postListsIdSegmentsId","pathRoute":"/list-segments/batch-add-or-remove-members","description":"Batch add/remove list members to static segment","summary":"Batch add or remove members","endpoint":"/lists/{list_id}/segments/{segment_id}","verb":"post","tags":["lists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.lists.batchSegmentMembers(\n    {},\n    \"list_id\",\n    \"segment_id\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->lists->batchSegmentMembers([], \"list_id\", \"segment_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.lists.batch_segment_members({}, \"list_id\", \"segment_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.lists.batch_segment_members({}, 'list_id', 'segment_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n  https://${dc}.api.mailchimp.com/3.0/lists/{list_id}/segments/{segment_id} \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"members_to_add\":[],\"members_to_remove\":[]}'"}]}],"sectionParent":{"sectionAnchor":"lists","sectionTitle":"Lists/Audiences"}},{"sectionTitle":"Signup Forms","sectionAnchor":"list-signup-forms","sectionDescription":"Manage list signup forms.","sectionRoute":"/list-signup-forms","paths":[{"operationId":"getListsIdSignupForms","pathRoute":"/list-signup-forms/list-signup-forms","description":"Get signup forms for a specific list.","summary":"List signup forms","endpoint":"/lists/{list_id}/signup-forms","verb":"get","tags":["lists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.lists.getListSignupForms(\"list_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->lists->getListSignupForms(\"list_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.lists.get_list_signup_forms(\"list_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.lists.get_list_signup_forms('list_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  https://${dc}.api.mailchimp.com/3.0/lists/{list_id}/signup-forms \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"postListsIdSignupForms","pathRoute":"/list-signup-forms/customize-signup-form","description":"Customize a list's default signup form.","summary":"Customize signup form","endpoint":"/lists/{list_id}/signup-forms","verb":"post","tags":["lists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.lists.updateListSignupForm(\"list_id\", {});\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->lists->updateListSignupForm(\"list_id\", []);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.lists.update_list_signup_form(\"list_id\", {})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.lists.update_list_signup_form('list_id', {})\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n  https://${dc}.api.mailchimp.com/3.0/lists/{list_id}/signup-forms \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"header\":{\"image_url\":\"\",\"text\":\"\",\"image_width\":\"\",\"image_height\":\"\",\"image_alt\":\"\",\"image_link\":\"\",\"image_align\":\"none\",\"image_border_width\":\"\",\"image_border_style\":\"none\",\"image_border_color\":\"\",\"image_target\":\"_blank\"},\"contents\":[],\"styles\":[]}'"}]}],"sectionParent":{"sectionAnchor":"lists","sectionTitle":"Lists/Audiences"}},{"sectionTitle":"Surveys","sectionAnchor":"list-surveys","sectionDescription":"Get survey data for this audience.","sectionRoute":"/list-surveys","paths":[{"operationId":"getListsIdSurveys","pathRoute":"/list-surveys/get-information-about-all-surveys-for-a-list","description":"Get information about all available surveys for a specific list.","summary":"Get information about all surveys for a list","endpoint":"/lists/{list_id}/surveys","verb":"get","tags":["lists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.lists.getAllSurveysForList(\"list_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->lists->getAllSurveysForList(\"list_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.lists.get_all_surveys_for_list(\"list_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.lists.get_all_surveys_for_list('list_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  https://${dc}.api.mailchimp.com/3.0/lists/{list_id}/surveys \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"getListsIdSurveysId","pathRoute":"/list-surveys/get-survey","description":"Get details about a specific survey.","summary":"Get survey","endpoint":"/lists/{list_id}/surveys/{survey_id}","verb":"get","tags":["lists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.lists.getSurvey(\"list_id\", \"survey_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->lists->getSurvey(\"list_id\", \"survey_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.lists.get_survey(\"list_id\", \"survey_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.lists.get_survey('list_id', 'survey_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  https://${dc}.api.mailchimp.com/3.0/lists/{list_id}/surveys/{survey_id} \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"postListsIdSurveysIdActionsPublish","pathRoute":"/list-surveys/publish-a-survey","description":"Publish a survey that is in draft, unpublished, or has been previously published and edited.","summary":"Publish a Survey","endpoint":"/lists/{list_id}/surveys/{survey_id}/actions/publish","verb":"post","tags":["Surveys"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.Surveys.publishSurvey(\"list_id\", \"survey_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->Surveys->publishSurvey(\"list_id\", \"survey_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.Surveys.publish_survey(\"list_id\", \"survey_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.Surveys.publish_survey('list_id', 'survey_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n  https://${dc}.api.mailchimp.com/3.0/lists/{list_id}/surveys/{survey_id}/actions/publish \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"postListsIdSurveysIdActionsUnpublish","pathRoute":"/list-surveys/unpublish-a-survey","description":"Unpublish a survey that has been published.","summary":"Unpublish a Survey","endpoint":"/lists/{list_id}/surveys/{survey_id}/actions/unpublish","verb":"post","tags":["Surveys"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.Surveys.unpublishSurvey(\"list_id\", \"survey_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->Surveys->unpublishSurvey(\"list_id\", \"survey_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.Surveys.unpublish_survey(\"list_id\", \"survey_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.Surveys.unpublish_survey('list_id', 'survey_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n  https://${dc}.api.mailchimp.com/3.0/lists/{list_id}/surveys/{survey_id}/actions/unpublish \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"postListsIdSurveysIdActionsCreateEmail","pathRoute":"/list-surveys/create-a-survey-campaign","description":"Utilize the List ID and Survey ID to generate a Campaign that links to your survey.","summary":"Create a Survey Campaign","endpoint":"/lists/{list_id}/surveys/{survey_id}/actions/create-email","verb":"post","tags":["Surveys"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.Surveys.createEmail(\"list_id\", \"survey_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->Surveys->createEmail(\"list_id\", \"survey_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.Surveys.create_email(\"list_id\", \"survey_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.Surveys.create_email('list_id', 'survey_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n  https://${dc}.api.mailchimp.com/3.0/lists/{list_id}/surveys/{survey_id}/actions/create-email \\\n  --user \"anystring:${apikey}\"'"}]}],"sectionParent":{"sectionAnchor":"lists","sectionTitle":"Lists/Audiences"}},{"sectionTitle":"Tag Search","sectionAnchor":"lists-tags-search","sectionDescription":"Search for tags on a list by name.","sectionRoute":"/lists-tags-search","paths":[{"operationId":"searchTagsByName","pathRoute":"/lists-tags-search/search-for-tags-on-a-list-by-name","description":"Search for tags on a list by name. If no name is provided, will return all tags on the list.","summary":"Search for tags on a list by name.","endpoint":"/lists/{list_id}/tag-search","verb":"get","tags":["lists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.lists.tagSearch(\"list_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->lists->tagSearch(\"list_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.lists.tag_search(\"list_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.lists.tag_search('list_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/lists/{list_id}/tag-search?name=<SOME_STRING_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]}],"sectionParent":{"sectionAnchor":"lists","sectionTitle":"Lists/Audiences"}},{"sectionTitle":"Webhooks","sectionAnchor":"list-webhooks","sectionDescription":"Manage webhooks for a specific Mailchimp list.","sectionRoute":"/list-webhooks","paths":[{"operationId":"getListsIdWebhooks","pathRoute":"/list-webhooks/list-webhooks","description":"Get information about all webhooks for a specific list.","summary":"List webhooks","endpoint":"/lists/{list_id}/webhooks","verb":"get","tags":["lists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.lists.getListWebhooks(\"list_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->lists->getListWebhooks(\"list_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.lists.get_list_webhooks(\"list_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.lists.get_list_webhooks('list_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  https://${dc}.api.mailchimp.com/3.0/lists/{list_id}/webhooks \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"postListsIdWebhooks","pathRoute":"/list-webhooks/add-webhook","description":"Create a new webhook for a specific list.","summary":"Add webhook","endpoint":"/lists/{list_id}/webhooks","verb":"post","tags":["lists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.lists.createListWebhook(\"list_id\", {});\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->lists->createListWebhook(\"list_id\", []);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.lists.create_list_webhook(\"list_id\", {})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.lists.create_list_webhook('list_id', {})\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n  https://${dc}.api.mailchimp.com/3.0/lists/{list_id}/webhooks \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"url\":\"\",\"events\":{\"subscribe\":false,\"unsubscribe\":false,\"profile\":false,\"cleaned\":false,\"upemail\":false,\"campaign\":false},\"sources\":{\"user\":false,\"admin\":false,\"api\":false}}'"}]},{"operationId":"getListsIdWebhooksId","pathRoute":"/list-webhooks/get-webhook-info","description":"Get information about a specific webhook.","summary":"Get webhook info","endpoint":"/lists/{list_id}/webhooks/{webhook_id}","verb":"get","tags":["lists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.lists.getListWebhook(\"list_id\", \"webhook_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->lists->getListWebhook(\"list_id\", \"webhook_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.lists.get_list_webhook(\"list_id\", \"webhook_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.lists.get_list_webhook('list_id', 'webhook_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  https://${dc}.api.mailchimp.com/3.0/lists/{list_id}/webhooks/{webhook_id} \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"deleteListsIdWebhooksId","pathRoute":"/list-webhooks/delete-webhook","description":"Delete a specific webhook in a list.","summary":"Delete webhook","endpoint":"/lists/{list_id}/webhooks/{webhook_id}","verb":"delete","tags":["lists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.lists.deleteListWebhook(\n    \"list_id\",\n    \"webhook_id\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->lists->deleteListWebhook(\"list_id\", \"webhook_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.lists.delete_list_webhook(\"list_id\", \"webhook_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.lists.delete_list_webhook('list_id', 'webhook_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X DELETE \\\n  https://${dc}.api.mailchimp.com/3.0/lists/{list_id}/webhooks/{webhook_id} \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"patchListsIdWebhooksId","pathRoute":"/list-webhooks/update-webhook","description":"Update the settings for an existing webhook.","summary":"Update webhook","endpoint":"/lists/{list_id}/webhooks/{webhook_id}","verb":"patch","tags":["lists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.lists.updateListWebhook(\n    \"list_id\",\n    \"webhook_id\",\n    {}\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->lists->updateListWebhook(\"list_id\", \"webhook_id\", []);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.lists.update_list_webhook(\"list_id\", \"webhook_id\", {})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.lists.update_list_webhook('list_id', 'webhook_id', {})\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X PATCH \\\n  https://${dc}.api.mailchimp.com/3.0/lists/{list_id}/webhooks/{webhook_id} \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"url\":\"\",\"events\":{\"subscribe\":false,\"unsubscribe\":false,\"profile\":false,\"cleaned\":false,\"upemail\":false,\"campaign\":false},\"sources\":{\"user\":false,\"admin\":false,\"api\":false}}'"}]}],"sectionParent":{"sectionAnchor":"lists","sectionTitle":"Lists/Audiences"}}]},{"sectionTitle":"Ping","sectionAnchor":"ping","sectionDescription":"A health check endpoint for Mailchimp API 3.0.","sectionRoute":"/ping","paths":[{"operationId":"getPing","pathRoute":"/ping/ping","description":"A health check for the API that won't return any account-specific information.","summary":"Ping","endpoint":"/ping","verb":"get","tags":["ping"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.ping.get();\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->ping->get();\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.ping.get()\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.ping.get\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  https://${dc}.api.mailchimp.com/3.0/ping \\\n  --user \"anystring:${apikey}\"'"}]}],"subSections":[]},{"sectionTitle":"Reporting","sectionAnchor":"reporting","sectionDescription":"Reporting for various campaign types.","sectionRoute":"/reporting","paths":[],"subSections":[{"sectionTitle":"Facebook Ads","sectionAnchor":"reporting-facebook-ads","sectionDescription":"Get information about Facebook Ad reports. ","sectionRoute":"/reporting-facebook-ads","paths":[{"operationId":"getReportingFacebookAds","pathRoute":"/reporting-facebook-ads/list-facebook-ads-reports","description":"Get reports of Facebook ads.","summary":"List facebook ads reports","endpoint":"/reporting/facebook-ads","verb":"get","tags":["reporting"],"deprecated":null,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.reporting.getFacebookAdsReportAll();\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->reporting->getFacebookAdsReportAll();\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.reporting.get_facebook_ads_report_all()\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.reporting.get_facebook_ads_report_all\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/reporting/facebook-ads?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>&count=10&offset=0&sort_field=<SOME_STRING_VALUE>&sort_dir=<SOME_STRING_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"getReportingFacebookAdsId","pathRoute":"/reporting-facebook-ads/get-facebook-ad-report","description":"Get report of a Facebook ad.","summary":"Get facebook ad report","endpoint":"/reporting/facebook-ads/{outreach_id}","verb":"get","tags":["reporting"],"deprecated":null,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.reporting.getFacebookAdReport(\"outreach_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->reporting->getFacebookAdReport(\"outreach_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.reporting.get_facebook_ad_report(\"outreach_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.reporting.get_facebook_ad_report('outreach_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/reporting/facebook-ads/{outreach_id}?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"getReportingFacebookAdsIdEcommerceProductActivity","pathRoute":"/reporting-facebook-ads/list-facebook-ecommerce-report","description":"Get breakdown of product activity for an outreach.","summary":"List facebook ecommerce report","endpoint":"/reporting/facebook-ads/{outreach_id}/ecommerce-product-activity","verb":"get","tags":["reporting"],"deprecated":null,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.reporting.getFacebookAdProductActivityReport(\n    \"outreach_id\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->reporting->getFacebookAdProductActivityReport(\n    \"outreach_id\"\n);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.reporting.get_facebook_ad_product_activity_report(\"outreach_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.reporting.get_facebook_ad_product_activity_report('outreach_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/reporting/facebook-ads/{outreach_id}/ecommerce-product-activity?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>&count=10&offset=0&sort_field=<SOME_STRING_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]}],"sectionParent":{"sectionAnchor":"reporting","sectionTitle":"Reporting"}},{"sectionTitle":"Landing Pages","sectionAnchor":"reporting-landing-pages","sectionDescription":"Get information about Landing Page reports.","sectionRoute":"/reporting-landing-pages","paths":[{"operationId":"getReportingLandingPages","pathRoute":"/reporting-landing-pages/list-landing-pages-reports","description":"Get reports of landing pages.","summary":"List landing pages reports","endpoint":"/reporting/landing-pages","verb":"get","tags":["reporting"],"deprecated":null,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.reporting.getLandingPageReportsAll();\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->reporting->getLandingPageReportsAll();\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.reporting.get_landing_page_reports_all()\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.reporting.get_landing_page_reports_all\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/reporting/landing-pages?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>&count=10&offset=0' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"getReportingLandingPagesId","pathRoute":"/reporting-landing-pages/get-landing-page-report","description":"Get report of a landing page.","summary":"Get landing page report","endpoint":"/reporting/landing-pages/{outreach_id}","verb":"get","tags":["reporting"],"deprecated":null,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.reporting.getLandingPageReport(\"outreach_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->reporting->getLandingPageReport(\"outreach_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.reporting.get_landing_page_report(\"outreach_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.reporting.get_landing_page_report('outreach_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/reporting/landing-pages/{outreach_id}?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]}],"sectionParent":{"sectionAnchor":"reporting","sectionTitle":"Reporting"}},{"sectionTitle":"Survey Question Answers","sectionAnchor":"reporting-surveys-questions-answers","sectionDescription":"Answers to specific questions on a [hosted survey](https://mailchimp.com/help/create-a-survey/).","sectionRoute":"/reporting-surveys-questions-answers","paths":[{"operationId":"getReportingSurveysIdQuestionsIdAnswers","pathRoute":"/reporting-surveys-questions-answers/list-answers-for-question","description":"Get answers for a survey question.","summary":"List answers for question","endpoint":"/reporting/surveys/{survey_id}/questions/{question_id}/answers","verb":"get","tags":["reporting"],"deprecated":null,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.reporting.getSurveyQuestionAnswers(\n    \"survey_id\",\n    \"question_id\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->reporting->getSurveyQuestionAnswers(\n    \"survey_id\",\n    \"question_id\"\n);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.reporting.get_survey_question_answers(\"survey_id\", \"question_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.reporting.get_survey_question_answers('survey_id', 'question_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/reporting/surveys/{survey_id}/questions/{question_id}/answers?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>&respondent_familiarity_is=<SOME_STRING_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]}],"sectionParent":{"sectionAnchor":"reporting","sectionTitle":"Reporting"}},{"sectionTitle":"Survey Questions","sectionAnchor":"reporting-surveys-questions","sectionDescription":"Get reports by question on a [hosted survey](https://mailchimp.com/help/create-a-survey/).","sectionRoute":"/reporting-surveys-questions","paths":[{"operationId":"getReportingSurveysIdQuestions","pathRoute":"/reporting-surveys-questions/list-survey-question-reports","description":"Get reports for survey questions.","summary":"List survey question reports","endpoint":"/reporting/surveys/{survey_id}/questions","verb":"get","tags":["reporting"],"deprecated":null,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.reporting.getSurveyQuestionReportsAll(\n    \"survey_id\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->reporting->getSurveyQuestionReportsAll(\"survey_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.reporting.get_survey_question_reports_all(\"survey_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.reporting.get_survey_question_reports_all('survey_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/reporting/surveys/{survey_id}/questions?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"getReportingSurveysIdQuestionsId","pathRoute":"/reporting-surveys-questions/get-survey-question-report","description":"Get report for a survey question.","summary":"Get survey question report","endpoint":"/reporting/surveys/{survey_id}/questions/{question_id}","verb":"get","tags":["reporting"],"deprecated":null,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.reporting.getSurveyQuestionReport(\n    \"survey_id\",\n    \"question_id\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->reporting->getSurveyQuestionReport(\n    \"survey_id\",\n    \"question_id\"\n);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.reporting.get_survey_question_report(\"survey_id\", \"question_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.reporting.get_survey_question_report('survey_id', 'question_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/reporting/surveys/{survey_id}/questions/{question_id}?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]}],"sectionParent":{"sectionAnchor":"reporting","sectionTitle":"Reporting"}},{"sectionTitle":"Survey Responses","sectionAnchor":"reporting-surveys-responses","sectionDescription":"Get survey response reports for a [hosted survey](https://mailchimp.com/help/create-a-survey/).","sectionRoute":"/reporting-surveys-responses","paths":[{"operationId":"getReportingSurveysIdResponses","pathRoute":"/reporting-surveys-responses/list-survey-responses","description":"Get responses to a survey.","summary":"List survey responses","endpoint":"/reporting/surveys/{survey_id}/responses","verb":"get","tags":["reporting"],"deprecated":null,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.reporting.getSurveyResponsesAll(\"survey_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->reporting->getSurveyResponsesAll(\"survey_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.reporting.get_survey_responses_all(\"survey_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.reporting.get_survey_responses_all('survey_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/reporting/surveys/{survey_id}/responses?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>&answered_question=<SOME_INTEGER_VALUE>&chose_answer=<SOME_STRING_VALUE>&respondent_familiarity_is=<SOME_STRING_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"getReportingSurveysIdResponsesId","pathRoute":"/reporting-surveys-responses/get-survey-response","description":"Get a single survey response.","summary":"Get survey response","endpoint":"/reporting/surveys/{survey_id}/responses/{response_id}","verb":"get","tags":["reporting"],"deprecated":null,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.reporting.getSurveyResponse(\n    \"survey_id\",\n    \"response_id\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->reporting->getSurveyResponse(\"survey_id\", \"response_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.reporting.get_survey_response(\"survey_id\", \"response_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.reporting.get_survey_response('survey_id', 'response_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  https://${dc}.api.mailchimp.com/3.0/reporting/surveys/{survey_id}/responses/{response_id} \\\n  --user \"anystring:${apikey}\"'"}]}],"sectionParent":{"sectionAnchor":"reporting","sectionTitle":"Reporting"}},{"sectionTitle":"Surveys","sectionAnchor":"reporting-surveys","sectionDescription":"Get an overall report for a [hosted survey](https://mailchimp.com/help/create-a-survey/).","sectionRoute":"/reporting-surveys","paths":[{"operationId":"getReportingSurveys","pathRoute":"/reporting-surveys/list-survey-reports","description":"Get reports for surveys.","summary":"List survey reports","endpoint":"/reporting/surveys","verb":"get","tags":["reporting"],"deprecated":null,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.reporting.getSurveyReportsAll();\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->reporting->getSurveyReportsAll();\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.reporting.get_survey_reports_all()\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.reporting.get_survey_reports_all\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/reporting/surveys?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>&count=10&offset=0' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"getReportingSurveysId","pathRoute":"/reporting-surveys/get-survey-report","description":"Get report for a survey.","summary":"Get survey report","endpoint":"/reporting/surveys/{survey_id}","verb":"get","tags":["reporting"],"deprecated":null,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.reporting.getSurveyReport(\"survey_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->reporting->getSurveyReport(\"survey_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.reporting.get_survey_report(\"survey_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.reporting.get_survey_report('survey_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/reporting/surveys/{survey_id}?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]}],"sectionParent":{"sectionAnchor":"reporting","sectionTitle":"Reporting"}}]},{"sectionTitle":"Reports","sectionAnchor":"reports","sectionDescription":"Manage campaign reports for your Mailchimp account. All Reports endpoints are read-only. Mailchimp's campaign and automation reports analyze clicks, opens, subscribers' social activity, e-commerce data, and more. Note: Campaign IDs for A/B Testing Campaigns are available through the Campaign API Endpoint's Read method.","sectionRoute":"/reports","paths":[{"operationId":"getReports","pathRoute":"/reports/list-campaign-reports","description":"Get campaign reports.","summary":"List campaign reports","endpoint":"/reports","verb":"get","tags":["reports"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.reports.getAllCampaignReports();\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->reports->getAllCampaignReports();\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.reports.get_all_campaign_reports()\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.reports.get_all_campaign_reports\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/reports?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>&count=10&offset=0&type=<SOME_STRING_VALUE>&before_send_time=<SOME_STRING_VALUE>&since_send_time=<SOME_STRING_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"getReportsId","pathRoute":"/reports/get-campaign-report","description":"Get report details for a specific sent campaign.","summary":"Get campaign report","endpoint":"/reports/{campaign_id}","verb":"get","tags":["reports"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.reports.getCampaignReport(\"campaign_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->reports->getCampaignReport(\"campaign_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.reports.get_campaign_report(\"campaign_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.reports.get_campaign_report('campaign_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/reports/{campaign_id}?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]}],"subSections":[{"sectionTitle":"Campaign Abuse","sectionAnchor":"campaign-abuse","sectionDescription":"Get information about campaign abuse complaints.","sectionRoute":"/campaign-abuse","paths":[{"operationId":"getReportsIdAbuseReportsId","pathRoute":"/campaign-abuse/list-abuse-reports","description":"Get a list of abuse complaints for a specific campaign.","summary":"List abuse reports","endpoint":"/reports/{campaign_id}/abuse-reports","verb":"get","tags":["reports"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.reports.getCampaignAbuseReports(\"campaign_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->reports->getCampaignAbuseReports(\"campaign_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.reports.get_campaign_abuse_reports(\"campaign_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.reports.get_campaign_abuse_reports('campaign_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/reports/{campaign_id}/abuse-reports?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"getReportsIdAbuseReportsIdId","pathRoute":"/campaign-abuse/get-abuse-report","description":"Get information about a specific abuse report for a campaign.","summary":"Get abuse report","endpoint":"/reports/{campaign_id}/abuse-reports/{report_id}","verb":"get","tags":["reports"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.reports.getCampaignAbuseReport(\n    \"campaign_id\",\n    \"report_id\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->reports->getCampaignAbuseReport(\n    \"campaign_id\",\n    \"report_id\"\n);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.reports.get_campaign_abuse_report(\"campaign_id\", \"report_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.reports.get_campaign_abuse_report('campaign_id', 'report_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/reports/{campaign_id}/abuse-reports/{report_id}?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]}],"sectionParent":{"sectionAnchor":"reports","sectionTitle":"Reports"}},{"sectionTitle":"Campaign Advice","sectionAnchor":"campaign-advice","sectionDescription":"Get recent feedback based on a campaign's statistics.","sectionRoute":"/campaign-advice","paths":[{"operationId":"getReportsIdAdvice","pathRoute":"/campaign-advice/list-campaign-feedback","description":"Get feedback based on a campaign's statistics. Advice feedback is based on campaign stats like opens, clicks, unsubscribes, bounces, and more.","summary":"List campaign feedback","endpoint":"/reports/{campaign_id}/advice","verb":"get","tags":["reports"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.reports.getCampaignAdvice(\"campaign_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->reports->getCampaignAdvice(\"campaign_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.reports.get_campaign_advice(\"campaign_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.reports.get_campaign_advice('campaign_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/reports/{campaign_id}/advice?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]}],"sectionParent":{"sectionAnchor":"reports","sectionTitle":"Reports"}},{"sectionTitle":"Campaign Open Reports","sectionAnchor":"open-reports","sectionDescription":"Get a detailed report about any emails in a specific campaign that were opened by the recipient. ","sectionRoute":"/open-reports","paths":[{"operationId":"getReportsIdOpenDetails","pathRoute":"/open-reports/list-campaign-open-details","description":"Get detailed information about any campaign emails that were opened by a list member.","summary":"List campaign open details","endpoint":"/reports/{campaign_id}/open-details","verb":"get","tags":["reports"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.reports.getCampaignOpenDetails(\"campaign_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->reports->getCampaignOpenDetails(\"campaign_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.reports.get_campaign_open_details(\"campaign_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.reports.get_campaign_open_details('campaign_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/reports/{campaign_id}/open-details?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>&count=10&offset=0&since=<SOME_STRING_VALUE>&sort_field=<SOME_STRING_VALUE>&sort_dir=<SOME_STRING_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"getReportsIdOpenDetailsIdMembersId","pathRoute":"/open-reports/get-opened-campaign-subscriber","description":"Get information about a specific subscriber who opened a campaign.","summary":"Get opened campaign subscriber","endpoint":"/reports/{campaign_id}/open-details/{subscriber_hash}","verb":"get","tags":["reports"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.reports.getSubscriberInfoForOpenedCampaign(\n    \"campaign_id\",\n    \"subscriber_hash\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->reports->getSubscriberInfoForOpenedCampaign(\n    \"campaign_id\",\n    \"subscriber_hash\"\n);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.reports.get_subscriber_info_for_opened_campaign(\"campaign_id\", \"subscriber_hash\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.reports.get_subscriber_info_for_opened_campaign(\n      'campaign_id',\n      'subscriber_hash'\n    )\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/reports/{campaign_id}/open-details/{subscriber_hash}?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]}],"sectionParent":{"sectionAnchor":"reports","sectionTitle":"Reports"}},{"sectionTitle":"Click Reports","sectionAnchor":"click-reports","sectionDescription":"Get detailed information about links clicked in campaigns.","sectionRoute":"/click-reports","paths":[{"operationId":"getReportsIdClickDetails","pathRoute":"/click-reports/list-campaign-details","description":"Get information about clicks on specific links in your Mailchimp campaigns.","summary":"List campaign details","endpoint":"/reports/{campaign_id}/click-details","verb":"get","tags":["reports"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.reports.getCampaignClickDetails(\"campaign_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->reports->getCampaignClickDetails(\"campaign_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.reports.get_campaign_click_details(\"campaign_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.reports.get_campaign_click_details('campaign_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/reports/{campaign_id}/click-details?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>&count=10&offset=0&sort_field=<SOME_STRING_VALUE>&sort_dir=<SOME_STRING_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"getReportsIdClickDetailsId","pathRoute":"/click-reports/get-campaign-link-details","description":"Get click details for a specific link in a campaign.","summary":"Get campaign link details","endpoint":"/reports/{campaign_id}/click-details/{link_id}","verb":"get","tags":["reports"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.reports.getCampaignClickDetailsForLink(\n    \"campaign_id\",\n    \"link_id\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->reports->getCampaignClickDetailsForLink(\n    \"campaign_id\",\n    \"link_id\"\n);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.reports.get_campaign_click_details_for_link(\"campaign_id\", \"link_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.reports.get_campaign_click_details_for_link('campaign_id', 'link_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/reports/{campaign_id}/click-details/{link_id}?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]}],"sectionParent":{"sectionAnchor":"reports","sectionTitle":"Reports"}},{"sectionTitle":"Click Reports Members","sectionAnchor":"link-clickers","sectionDescription":"Get information about specific subscribers who clicked on links in a campaign.","sectionRoute":"/link-clickers","paths":[{"operationId":"getReportsIdClickDetailsIdMembers","pathRoute":"/link-clickers/list-clicked-link-subscribers","description":"Get information about list members who clicked on a specific link in a campaign.","summary":"List clicked link subscribers","endpoint":"/reports/{campaign_id}/click-details/{link_id}/members","verb":"get","tags":["reports"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.reports.getSubscribersInfo(\n    \"campaign_id\",\n    \"link_id\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->reports->getSubscribersInfo(\"campaign_id\", \"link_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.reports.get_subscribers_info(\"campaign_id\", \"link_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.reports.get_subscribers_info('campaign_id', 'link_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/reports/{campaign_id}/click-details/{link_id}/members?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>&count=10&offset=0' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"getReportsIdClickDetailsIdMembersId","pathRoute":"/link-clickers/get-clicked-link-subscriber","description":"Get information about a specific subscriber who clicked a link in a specific campaign.","summary":"Get clicked link subscriber","endpoint":"/reports/{campaign_id}/click-details/{link_id}/members/{subscriber_hash}","verb":"get","tags":["reports"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.reports.getSubscriberInfo(\n    \"campaign_id\",\n    \"link_id\",\n    \"subscriber_hash\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->reports->getSubscriberInfo(\n    \"campaign_id\",\n    \"link_id\",\n    \"subscriber_hash\"\n);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.reports.get_subscriber_info(\"campaign_id\", \"link_id\", \"subscriber_hash\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.reports.get_subscriber_info(\n      'campaign_id',\n      'link_id',\n      'subscriber_hash'\n    )\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/reports/{campaign_id}/click-details/{link_id}/members/{subscriber_hash}?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]}],"sectionParent":{"sectionAnchor":"reports","sectionTitle":"Reports"}},{"sectionTitle":"Domain Performance","sectionAnchor":"domain-performance-reports","sectionDescription":"Get statistics for the top-performing domains from a campaign.","sectionRoute":"/domain-performance-reports","paths":[{"operationId":"getReportsIdDomainPerformance","pathRoute":"/domain-performance-reports/list-domain-performance-stats","description":"Get statistics for the top-performing email domains in a campaign.","summary":"List domain performance stats","endpoint":"/reports/{campaign_id}/domain-performance","verb":"get","tags":["reports"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.reports.getDomainPerformanceForCampaign(\n    \"campaign_id\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->reports->getDomainPerformanceForCampaign(\"campaign_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.reports.get_domain_performance_for_campaign(\"campaign_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.reports.get_domain_performance_for_campaign('campaign_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/reports/{campaign_id}/domain-performance?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]}],"sectionParent":{"sectionAnchor":"reports","sectionTitle":"Reports"}},{"sectionTitle":"Ecommerce Product Activity","sectionAnchor":"campaign-ecommerce-product-activity","sectionDescription":"Ecommerce product activity report for a campaign.","sectionRoute":"/campaign-ecommerce-product-activity","paths":[{"operationId":"getReportsIdEcommerceProductActivity","pathRoute":"/campaign-ecommerce-product-activity/list-campaign-product-activity","description":"Get breakdown of product activity for a campaign","summary":"List campaign product activity","endpoint":"/reports/{campaign_id}/ecommerce-product-activity","verb":"get","tags":["reports"],"deprecated":null,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.reports.getEcommerceProductActivityForCampaign(\n    \"campaign_id\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->reports->getEcommerceProductActivityForCampaign(\n    \"campaign_id\"\n);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.reports.get_ecommerce_product_activity_for_campaign(\"campaign_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.reports.get_ecommerce_product_activity_for_campaign('campaign_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/reports/{campaign_id}/ecommerce-product-activity?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>&count=10&offset=0&sort_field=<SOME_STRING_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]}],"sectionParent":{"sectionAnchor":"reports","sectionTitle":"Reports"}},{"sectionTitle":"EepURL Reports","sectionAnchor":"eepurl-reports","sectionDescription":"Get a summary of social activity for the campaign, tracked by EepURL.","sectionRoute":"/eepurl-reports","paths":[{"operationId":"getReportsIdEepurl","pathRoute":"/eepurl-reports/list-eep-url-activity","description":"Get a summary of social activity for the campaign, tracked by EepURL.","summary":"List EepURL activity","endpoint":"/reports/{campaign_id}/eepurl","verb":"get","tags":["reports"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.reports.getEepurlActivityForCampaign(\n    \"campaign_id\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->reports->getEepurlActivityForCampaign(\"campaign_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.reports.get_eepurl_activity_for_campaign(\"campaign_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.reports.get_eepurl_activity_for_campaign('campaign_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/reports/{campaign_id}/eepurl?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]}],"sectionParent":{"sectionAnchor":"reports","sectionTitle":"Reports"}},{"sectionTitle":"Email Activity","sectionAnchor":"email-activity-reports","sectionDescription":"Get list member activity for a specific campaign.","sectionRoute":"/email-activity-reports","paths":[{"operationId":"getReportsIdEmailActivity","pathRoute":"/email-activity-reports/list-email-activity","description":"Get a list of member's subscriber activity in a specific campaign.","summary":"List email activity","endpoint":"/reports/{campaign_id}/email-activity","verb":"get","tags":["reports"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.reports.getEmailActivityForCampaign(\n    \"campaign_id\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->reports->getEmailActivityForCampaign(\"campaign_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.reports.get_email_activity_for_campaign(\"campaign_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.reports.get_email_activity_for_campaign('campaign_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/reports/{campaign_id}/email-activity?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>&count=10&offset=0&since=<SOME_STRING_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"getReportsIdEmailActivityId","pathRoute":"/email-activity-reports/get-subscriber-email-activity","description":"Get a specific list member's activity in a campaign including opens, clicks, and bounces.","summary":"Get subscriber email activity","endpoint":"/reports/{campaign_id}/email-activity/{subscriber_hash}","verb":"get","tags":["reports"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.reports.getEmailActivityForSubscriber(\n    \"campaign_id\",\n    \"subscriber_hash\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->reports->getEmailActivityForSubscriber(\n    \"campaign_id\",\n    \"subscriber_hash\"\n);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.reports.get_email_activity_for_subscriber(\"campaign_id\", \"subscriber_hash\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.reports.get_email_activity_for_subscriber(\n      'campaign_id',\n      'subscriber_hash'\n    )\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/reports/{campaign_id}/email-activity/{subscriber_hash}?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>&since=<SOME_STRING_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]}],"sectionParent":{"sectionAnchor":"reports","sectionTitle":"Reports"}},{"sectionTitle":"Location","sectionAnchor":"location-reports","sectionDescription":"Get top open locations for a specific campaign.","sectionRoute":"/location-reports","paths":[{"operationId":"getReportsIdLocations","pathRoute":"/location-reports/list-top-open-activities","description":"Get top open locations for a specific campaign.","summary":"List top open activities","endpoint":"/reports/{campaign_id}/locations","verb":"get","tags":["reports"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.reports.getLocationsForCampaign(\"campaign_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->reports->getLocationsForCampaign(\"campaign_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.reports.get_locations_for_campaign(\"campaign_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.reports.get_locations_for_campaign('campaign_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/reports/{campaign_id}/locations?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>&count=10&offset=0' \\\n  --user \"anystring:${apikey}\"'"}]}],"sectionParent":{"sectionAnchor":"reports","sectionTitle":"Reports"}},{"sectionTitle":"Sent To","sectionAnchor":"sent-to-reports","sectionDescription":"Get details about campaign recipients.","sectionRoute":"/sent-to-reports","paths":[{"operationId":"getReportsIdSentTo","pathRoute":"/sent-to-reports/list-campaign-recipients","description":"Get information about campaign recipients.","summary":"List campaign recipients","endpoint":"/reports/{campaign_id}/sent-to","verb":"get","tags":["reports"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.reports.getCampaignRecipients(\"campaign_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->reports->getCampaignRecipients(\"campaign_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.reports.get_campaign_recipients(\"campaign_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.reports.get_campaign_recipients('campaign_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/reports/{campaign_id}/sent-to?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>&count=10&offset=0' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"getReportsIdSentToId","pathRoute":"/sent-to-reports/get-campaign-recipient-info","description":"Get information about a specific campaign recipient.","summary":"Get campaign recipient info","endpoint":"/reports/{campaign_id}/sent-to/{subscriber_hash}","verb":"get","tags":["reports"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.reports.getCampaignRecipient(\n    \"campaign_id\",\n    \"subscriber_hash\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->reports->getCampaignRecipient(\n    \"campaign_id\",\n    \"subscriber_hash\"\n);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.reports.get_campaign_recipient(\"campaign_id\", \"subscriber_hash\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.reports.get_campaign_recipient('campaign_id', 'subscriber_hash')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/reports/{campaign_id}/sent-to/{subscriber_hash}?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]}],"sectionParent":{"sectionAnchor":"reports","sectionTitle":"Reports"}},{"sectionTitle":"Sub-Reports","sectionAnchor":"sub-reports","sectionDescription":"A list of reports for child campaigns of a specific parent campaign. For example, use this endpoint to view Multivariate, RSS, and A/B Testing Campaign reports.","sectionRoute":"/sub-reports","paths":[{"operationId":"getReportsIdSubReportsId","pathRoute":"/sub-reports/list-child-campaign-reports","description":"Get a list of reports with child campaigns for a specific parent campaign.","summary":"List child campaign reports","endpoint":"/reports/{campaign_id}/sub-reports","verb":"get","tags":["reports"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.reports.getSubReportsForCampaign(\"campaign_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->reports->getSubReportsForCampaign(\"campaign_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.reports.get_sub_reports_for_campaign(\"campaign_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.reports.get_sub_reports_for_campaign('campaign_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/reports/{campaign_id}/sub-reports?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]}],"sectionParent":{"sectionAnchor":"reports","sectionTitle":"Reports"}},{"sectionTitle":"Unsubscribes","sectionAnchor":"unsub-reports","sectionDescription":"Get information about list members who unsubscribed from a specific campaign.","sectionRoute":"/unsub-reports","paths":[{"operationId":"getReportsIdUnsubscribed","pathRoute":"/unsub-reports/list-unsubscribed-members","description":"Get information about members who have unsubscribed from a specific campaign.","summary":"List unsubscribed members","endpoint":"/reports/{campaign_id}/unsubscribed","verb":"get","tags":["reports"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.reports.getUnsubscribedListForCampaign(\n    \"campaign_id\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->reports->getUnsubscribedListForCampaign(\"campaign_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.reports.get_unsubscribed_list_for_campaign(\"campaign_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.reports.get_unsubscribed_list_for_campaign('campaign_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/reports/{campaign_id}/unsubscribed?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>&count=10&offset=0' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"getReportsIdUnsubscribedId","pathRoute":"/unsub-reports/get-unsubscribed-member","description":"Get information about a specific list member who unsubscribed from a campaign.","summary":"Get unsubscribed member","endpoint":"/reports/{campaign_id}/unsubscribed/{subscriber_hash}","verb":"get","tags":["reports"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.reports.getUnsubscribedListMember(\n    \"campaign_id\",\n    \"subscriber_hash\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->reports->getUnsubscribedListMember(\n    \"campaign_id\",\n    \"subscriber_hash\"\n);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.reports.get_unsubscribed_list_member(\"campaign_id\", \"subscriber_hash\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.reports.get_unsubscribed_list_member(\n      'campaign_id',\n      'subscriber_hash'\n    )\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/reports/{campaign_id}/unsubscribed/{subscriber_hash}?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]}],"sectionParent":{"sectionAnchor":"reports","sectionTitle":"Reports"}}]},{"sectionTitle":"Search Campaigns","sectionAnchor":"search-campaigns","sectionDescription":"Search all of an account's campaigns for the specified query terms.","sectionRoute":"/search-campaigns","paths":[{"operationId":"getSearchCampaigns","pathRoute":"/search-campaigns/search-campaigns","description":"Search all campaigns for the specified query terms.","summary":"Search campaigns","endpoint":"/search-campaigns","verb":"get","tags":["searchCampaigns"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.searchCampaigns.search(\"query\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->searchCampaigns->search(\"query\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.searchCampaigns.search(\"query\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.searchCampaigns.search('query')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/search-campaigns?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>&query=<SOME_STRING_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]}],"subSections":[]},{"sectionTitle":"Search Members","sectionAnchor":"search-members","sectionDescription":"Search the account or a specific list for members that match the specified query terms.","sectionRoute":"/search-members","paths":[{"operationId":"getSearchMembers","pathRoute":"/search-members/search-members","description":"Search for list members. This search can be restricted to a specific list, or can be used to search across all lists in an account.","summary":"Search members","endpoint":"/search-members","verb":"get","tags":["searchMembers"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.searchMembers.search(\"query\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->searchMembers->search(\"query\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.searchMembers.search(\"query\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.searchMembers.search('query')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/search-members?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>&query=<SOME_STRING_VALUE>&list_id=<SOME_STRING_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]}],"subSections":[]},{"sectionTitle":"Template Folders","sectionAnchor":"template-folders","sectionDescription":"Organize your templates using folders.","sectionRoute":"/template-folders","paths":[{"operationId":"getTemplateFolders","pathRoute":"/template-folders/list-template-folders","description":"Get all folders used to organize templates.","summary":"List template folders","endpoint":"/template-folders","verb":"get","tags":["templateFolders"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.templateFolders.list();\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->templateFolders->list();\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.templateFolders.list()\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.templateFolders.list\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/template-folders?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>&count=10&offset=0' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"postTemplateFolders","pathRoute":"/template-folders/add-template-folder","description":"Create a new template folder.","summary":"Add template folder","endpoint":"/template-folders","verb":"post","tags":["templateFolders"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.templateFolders.create({ name: \"name\" });\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->templateFolders->create([\"name\" => \"name\"]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.templateFolders.create({\"name\": \"name\"})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.templateFolders.create({ 'name' => 'name' })\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n  https://${dc}.api.mailchimp.com/3.0/template-folders \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"name\":\"\"}'"}]},{"operationId":"getTemplateFoldersId","pathRoute":"/template-folders/get-template-folder","description":"Get information about a specific folder used to organize templates.","summary":"Get template folder","endpoint":"/template-folders/{folder_id}","verb":"get","tags":["templateFolders"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.templateFolders.get(\"folder_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->templateFolders->get(\"folder_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.templateFolders.get(\"folder_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.templateFolders.get('folder_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/template-folders/{folder_id}?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"patchTemplateFoldersId","pathRoute":"/template-folders/update-template-folder","description":"Update a specific folder used to organize templates.","summary":"Update template folder","endpoint":"/template-folders/{folder_id}","verb":"patch","tags":["templateFolders"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.templateFolders.update(\"folder_id\", {\n    name: \"name\",\n  });\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->templateFolders->update(\"folder_id\", [\"name\" => \"name\"]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.templateFolders.update(\"folder_id\", {\"name\": \"name\"})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.templateFolders.update('folder_id', { 'name' => 'name' })\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X PATCH \\\n  https://${dc}.api.mailchimp.com/3.0/template-folders/{folder_id} \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"name\":\"\"}'"}]},{"operationId":"deleteTemplateFoldersId","pathRoute":"/template-folders/delete-template-folder","description":"Delete a specific template folder, and mark all the templates in the folder as 'unfiled'.","summary":"Delete template folder","endpoint":"/template-folders/{folder_id}","verb":"delete","tags":["templateFolders"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.templateFolders.remove(\"folder_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->templateFolders->remove(\"folder_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.templateFolders.remove(\"folder_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.templateFolders.remove('folder_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X DELETE \\\n  https://${dc}.api.mailchimp.com/3.0/template-folders/{folder_id} \\\n  --user \"anystring:${apikey}\"'"}]}],"subSections":[]},{"sectionTitle":"Templates","sectionAnchor":"templates","sectionDescription":"Manage your Mailchimp templates. A template is an HTML file used to create the layout and basic design for a campaign. ","sectionRoute":"/templates","paths":[{"operationId":"getTemplates","pathRoute":"/templates/list-templates","description":"Get a list of an account's available templates.","summary":"List templates","endpoint":"/templates","verb":"get","tags":["templates"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.templates.list();\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->templates->list();\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.templates.list()\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.templates.list\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/templates?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>&count=10&offset=0&created_by=<SOME_STRING_VALUE>&since_date_created=<SOME_STRING_VALUE>&before_date_created=<SOME_STRING_VALUE>&type=<SOME_STRING_VALUE>&category=<SOME_STRING_VALUE>&folder_id=<SOME_STRING_VALUE>&sort_field=<SOME_STRING_VALUE>&content_type=<SOME_STRING_VALUE>&sort_dir=<SOME_STRING_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"postTemplates","pathRoute":"/templates/add-template","description":"Create a new template for the account. Only Classic templates are supported.","summary":"Add template","endpoint":"/templates","verb":"post","tags":["templates"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.templates.create({\n    name: \"Freddie's Jokes\",\n    html: \"html\",\n  });\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->templates->create([\n    \"name\" => \"Freddie's Jokes\",\n    \"html\" => \"html\",\n]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.templates.create({\"name\": \"Freddie's Jokes\", \"html\": \"html\"})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.templates.create({ 'name' => \"Freddie's Jokes\", 'html' => 'html' })\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n  https://${dc}.api.mailchimp.com/3.0/templates \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"name\":\"\",\"folder_id\":\"\",\"html\":\"\"}'"}]},{"operationId":"getTemplatesId","pathRoute":"/templates/get-template-info","description":"Get information about a specific template.","summary":"Get template info","endpoint":"/templates/{template_id}","verb":"get","tags":["templates"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.templates.getTemplate(\"template_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->templates->getTemplate(\"template_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.templates.get_template(\"template_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.templates.get_template('template_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/templates/{template_id}?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"patchTemplatesId","pathRoute":"/templates/update-template","description":"Update the name, HTML, or `folder_id` of an existing template.","summary":"Update template","endpoint":"/templates/{template_id}","verb":"patch","tags":["templates"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.templates.updateTemplate(\"template_id\", {\n    name: \"Freddie's Jokes\",\n    html: \"html\",\n  });\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->templates->updateTemplate(\"template_id\", [\n    \"name\" => \"Freddie's Jokes\",\n    \"html\" => \"html\",\n]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.templates.update_template(\"template_id\", {\"name\": \"Freddie's Jokes\", \"html\": \"html\"})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.templates.update_template(\n      'template_id',\n      { 'name' => \"Freddie's Jokes\", 'html' => 'html' }\n    )\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X PATCH \\\n  https://${dc}.api.mailchimp.com/3.0/templates/{template_id} \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"name\":\"\",\"folder_id\":\"\",\"html\":\"\"}'"}]},{"operationId":"deleteTemplatesId","pathRoute":"/templates/delete-template","description":"Delete a specific template.","summary":"Delete template","endpoint":"/templates/{template_id}","verb":"delete","tags":["templates"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.templates.deleteTemplate(\"template_id\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->templates->deleteTemplate(\"template_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.templates.delete_template(\"template_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.templates.delete_template('template_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X DELETE \\\n  https://${dc}.api.mailchimp.com/3.0/templates/{template_id} \\\n  --user \"anystring:${apikey}\"'"}]}],"subSections":[{"sectionTitle":"Default Content","sectionAnchor":"template-default-content","sectionDescription":"Manage the default content for a Mailchimp template.","sectionRoute":"/template-default-content","paths":[{"operationId":"getTemplatesIdDefaultContent","pathRoute":"/template-default-content/view-default-content","description":"Get the sections that you can edit in a template, including each section's default content.","summary":"View default content","endpoint":"/templates/{template_id}/default-content","verb":"get","tags":["templates"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.templates.getDefaultContentForTemplate(\n    \"template_id\"\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->templates->getDefaultContentForTemplate(\"template_id\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.templates.get_default_content_for_template(\"template_id\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.templates.get_default_content_for_template('template_id')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  'https://${dc}.api.mailchimp.com/3.0/templates/{template_id}/default-content?fields=<SOME_ARRAY_VALUE>&exclude_fields=<SOME_ARRAY_VALUE>' \\\n  --user \"anystring:${apikey}\"'"}]}],"sectionParent":{"sectionAnchor":"templates","sectionTitle":"Templates"}}]},{"sectionTitle":"Verified Domains","sectionAnchor":"verified-domains","sectionDescription":"Manage the domains on your account that can be used for sending email campaigns.","sectionRoute":"/verified-domains","paths":[{"operationId":"getVerifiedDomains","pathRoute":"/verified-domains/list-sending-domains","description":"Get all of the sending domains on the account.","summary":"List sending domains","endpoint":"/verified-domains","verb":"get","tags":["verifiedDomains"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.verifiedDomains.getVerifiedDomainsAll();\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->verifiedDomains->getVerifiedDomainsAll();\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.verifiedDomains.get_verified_domains_all()\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.verifiedDomains.get_verified_domains_all\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  https://${dc}.api.mailchimp.com/3.0/verified-domains \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"createVerifiedDomain","pathRoute":"/verified-domains/add-domain-to-account","description":"Add a domain to the account.","summary":"Add domain to account","endpoint":"/verified-domains","verb":"post","tags":["verifiedDomains"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.verifiedDomains.createVerifiedDomain({\n    verification_email: \"Imogene.Auer@hotmail.com\",\n  });\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->verifiedDomains->createVerifiedDomain([\n    \"verification_email\" => \"Lane_Watsica@yahoo.com\",\n]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.verifiedDomains.create_verified_domain({\"verification_email\": \"Kayli57@gmail.com\"})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.verifiedDomains.create_verified_domain(\n      { 'verification_email' => 'Kyla.Wilkinson67@yahoo.com' }\n    )\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n  https://${dc}.api.mailchimp.com/3.0/verified-domains \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"verification_email\":\"\"}'"}]},{"operationId":"getVerifiedDomain","pathRoute":"/verified-domains/get-domain-info","description":"Get the details for a single domain on the account.","summary":"Get domain info","endpoint":"/verified-domains/{domain_name}","verb":"get","tags":["verifiedDomains"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.verifiedDomains.getDomain(\"domain_name\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->verifiedDomains->getDomain(\"domain_name\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.verifiedDomains.get_domain(\"domain_name\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.verifiedDomains.get_domain('domain_name')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X GET \\\n  https://${dc}.api.mailchimp.com/3.0/verified-domains/{domain_name} \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"deleteVerifiedDomain","pathRoute":"/verified-domains/delete-domain","description":"Delete a verified domain from the account.","summary":"Delete domain","endpoint":"/verified-domains/{domain_name}","verb":"delete","tags":["verifiedDomains"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.verifiedDomains.deleteDomain(\"domain_name\");\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->verifiedDomains->deleteDomain(\"domain_name\");\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.verifiedDomains.delete_domain(\"domain_name\")\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response = client.verifiedDomains.delete_domain('domain_name')\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X DELETE \\\n  https://${dc}.api.mailchimp.com/3.0/verified-domains/{domain_name} \\\n  --user \"anystring:${apikey}\"'"}]},{"operationId":"verifyDomain","pathRoute":"/verified-domains/verify-domain","description":"Verify a domain for sending.","summary":"Verify domain","endpoint":"/verified-domains/{domain_name}/actions/verify","verb":"post","tags":["verifiedDomains"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const client = require(\"@mailchimp/mailchimp_marketing\");\n\nclient.setConfig({\n  apiKey: \"YOUR_API_KEY\",\n  server: \"YOUR_SERVER_PREFIX\",\n});\n\nconst run = async () => {\n  const response = await client.verifiedDomains.submitDomainVerification(\n    \"domain_name\",\n    { code: \"code\" }\n  );\n  console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"<?php\nrequire_once '/path/to/MailchimpMarketing/vendor/autoload.php';\n\n$client = new MailchimpMarketing\\ApiClient();\n$client->setConfig([\n    'apiKey' => 'YOUR_API_KEY',\n    'server' => 'YOUR_SERVER_PREFIX',\n]);\n\n$response = $client->verifiedDomains->submitDomainVerification(\"domain_name\", [\n    \"code\" => \"code\",\n]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_marketing as MailchimpMarketing\nfrom mailchimp_marketing.api_client import ApiClientError\n\ntry:\n  client = MailchimpMarketing.Client()\n  client.set_config({\n    \"api_key\": \"YOUR_API_KEY\",\n    \"server\": \"YOUR_SERVER_PREFIX\"\n  })\n\n  response = client.verifiedDomains.submit_domain_verification(\"domain_name\", {\"code\": \"code\"})\n  print(response)\nexcept ApiClientError as error:\n  print(\"Error: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpMarketing'\n\nbegin\n  client = MailchimpMarketing::Client.new\n  client.set_config({ api_key: 'YOUR_API_KEY', server: 'YOUR_SERVER_PREFIX' })\n\n  response =\n    client.verifiedDomains.submit_domain_verification(\n      'domain_name',\n      { 'code' => 'code' }\n    )\n  p response\nrescue MailchimpMarketing::ApiError => e\n  puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n  https://${dc}.api.mailchimp.com/3.0/verified-domains/{domain_name}/actions/verify \\\n  --user \"anystring:${apikey}\"' \\\n  -d '{\"code\":\"\"}'"}]}],"subSections":[]}]}},"pageContext":{"product":"marketing","productLink":"Marketing","productPages":["landing","guide","docs","reference"],"pageVariant":"reference","withGuideData":false,"withDocData":false,"withRefData":true,"withLandingPageData":false,"specVersion":"3.0.86","specPermalink":"https://github.com/mailchimp/mailchimp-client-lib-codegen/blob/main/spec/marketing.json","nodeType":"RefLanding"}},"staticQueryHashes":["1207002660","1376854140","279774122","302783970","3936069583"]}