{"componentChunkName":"component---src-pages-product-js","path":"/marketing/docs/fundamentals/","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}]}]},"docData":{"headline":"Fundamentals","slug":"fundamentals","priority":null,"description":"Learn the basics of the Mailchimp Marketing API.","contentSource":"Contentful","markdownSourceSlug":null,"markdownSourceNode":null,"contentList":[{"title":"The basics","forMarketersSidebar":null,"bodyRichText":{"raw":"{\"nodeType\":\"document\",\"data\":{},\"content\":[{\"nodeType\":\"paragraph\",\"content\":[{\"nodeType\":\"text\",\"value\":\"The Mailchimp Marketing API provides programmatic access to Mailchimp data and functionality, allowing developers to build custom features to do things like sync email activity and campaign analytics with their database, manage audiences and campaigns, and more.\",\"marks\":[],\"data\":{}}],\"data\":{}},{\"nodeType\":\"paragraph\",\"content\":[{\"nodeType\":\"text\",\"value\":\"To use the Marketing API, you need a Mailchimp account. What you can do with the API depends on what \",\"marks\":[],\"data\":{}},{\"nodeType\":\"hyperlink\",\"content\":[{\"nodeType\":\"text\",\"value\":\"level of Mailchimp plan\",\"marks\":[{\"type\":\"underline\"}],\"data\":{}}],\"data\":{\"uri\":\"https://us1.admin.mailchimp.com/account/billing-plan/\"}},{\"nodeType\":\"text\",\"value\":\" you have. Once you have an account and are logged in, you can \",\"marks\":[],\"data\":{}},{\"nodeType\":\"hyperlink\",\"content\":[{\"nodeType\":\"text\",\"value\":\"get an API key\",\"marks\":[{\"type\":\"underline\"}],\"data\":{}}],\"data\":{\"uri\":\"https://us1.admin.mailchimp.com/account/api/\"}},{\"nodeType\":\"text\",\"value\":\" and \",\"marks\":[],\"data\":{}},{\"nodeType\":\"hyperlink\",\"content\":[{\"nodeType\":\"text\",\"value\":\"begin making calls to the API\",\"marks\":[{\"type\":\"underline\"}],\"data\":{}}],\"data\":{\"uri\":\"/marketing/guides/quick-start/\"}},{\"nodeType\":\"text\",\"value\":\".\",\"marks\":[],\"data\":{}}],\"data\":{}},{\"nodeType\":\"heading-3\",\"content\":[{\"nodeType\":\"text\",\"value\":\"Using Mailchimp\",\"marks\":[],\"data\":{}}],\"data\":{}},{\"nodeType\":\"paragraph\",\"content\":[{\"nodeType\":\"text\",\"value\":\"Whether you’re managing your own campaigns, providing Mailchimp services to your customers or clients, or writing a mobile app, the Mailchimp Marketing API has features to manage and sync your contact data.\",\"marks\":[],\"data\":{}}],\"data\":{}},{\"nodeType\":\"paragraph\",\"content\":[{\"nodeType\":\"text\",\"value\":\"Audiences are at the core of sending campaigns with Mailchimp. You can use the Marketing API to \",\"marks\":[],\"data\":{}},{\"nodeType\":\"hyperlink\",\"content\":[{\"nodeType\":\"text\",\"value\":\"set up an audience\",\"marks\":[{\"type\":\"underline\"}],\"data\":{}}],\"data\":{\"uri\":\"/marketing/guides/create-your-first-audience/\"}},{\"nodeType\":\"text\",\"value\":\" and add contacts to that audience; you can then organize those contacts with \",\"marks\":[],\"data\":{}},{\"nodeType\":\"hyperlink\",\"content\":[{\"nodeType\":\"text\",\"value\":\"tags\",\"marks\":[{\"type\":\"underline\"}],\"data\":{}}],\"data\":{\"uri\":\"/marketing/guides/organize-contacts-with-tags/\"}},{\"nodeType\":\"text\",\"value\":\" or segment them by activity with \",\"marks\":[],\"data\":{}},{\"nodeType\":\"hyperlink\",\"content\":[{\"nodeType\":\"text\",\"value\":\"events\",\"marks\":[{\"type\":\"underline\"}],\"data\":{}}],\"data\":{\"uri\":\"/marketing/guides/track-outside-activity-events/\"}},{\"nodeType\":\"text\",\"value\":\".\",\"marks\":[],\"data\":{}}],\"data\":{}},{\"nodeType\":\"paragraph\",\"content\":[{\"nodeType\":\"text\",\"value\":\"The Marketing API can also be a source of data for your application. \",\"marks\":[],\"data\":{}},{\"nodeType\":\"hyperlink\",\"content\":[{\"nodeType\":\"text\",\"value\":\"Webhooks\",\"marks\":[{\"type\":\"underline\"}],\"data\":{}}],\"data\":{\"uri\":\"/marketing/guides/sync-audience-data-webhooks/\"}},{\"nodeType\":\"text\",\"value\":\" collect and transmit information about your audience to you in near real time. And if you’re selling products on an external store, you can integrate your audience behavior using Mailchimp’s  \",\"marks\":[],\"data\":{}},{\"nodeType\":\"hyperlink\",\"content\":[{\"nodeType\":\"text\",\"value\":\"E-commerce features\",\"marks\":[{\"type\":\"underline\"}],\"data\":{}}],\"data\":{\"uri\":\"/marketing/docs/e-commerce/\"}},{\"nodeType\":\"text\",\"value\":\".\",\"marks\":[],\"data\":{}}],\"data\":{}},{\"nodeType\":\"paragraph\",\"content\":[{\"nodeType\":\"text\",\"value\":\"You can also use the Marketing API to  handle data in different ways for different purposes. If you are syncing a large amount of data with Mailchimp, you can use \",\"marks\":[],\"data\":{}},{\"nodeType\":\"hyperlink\",\"content\":[{\"nodeType\":\"text\",\"value\":\"batches\",\"marks\":[{\"type\":\"underline\"}],\"data\":{}}],\"data\":{\"uri\":\"/marketing/guides/run-async-requests-batch-endpoint/\"}},{\"nodeType\":\"text\",\"value\":\" to avoid hitting the API request limits. For building integrations that let other users access data from their own Mailchimp accounts, you should \",\"marks\":[],\"data\":{}},{\"nodeType\":\"hyperlink\",\"content\":[{\"nodeType\":\"text\",\"value\":\"authenticate with OAuth 2\",\"marks\":[{\"type\":\"underline\"}],\"data\":{}}],\"data\":{\"uri\":\"/marketing/guides/access-user-data-oauth-2/\"}},{\"nodeType\":\"text\",\"value\":\". And if you’re developing an app for iOS or Android, the \",\"marks\":[],\"data\":{}},{\"nodeType\":\"hyperlink\",\"content\":[{\"nodeType\":\"text\",\"value\":\"Mobile SDK\",\"marks\":[{\"type\":\"underline\"}],\"data\":{}}],\"data\":{\"uri\":\"/marketing/docs/mobile-sdk/\"}},{\"nodeType\":\"text\",\"value\":\" provides an easy way to work with a mobile-focused subset of the Marketing API’s functionality.\",\"marks\":[],\"data\":{}}],\"data\":{}},{\"nodeType\":\"heading-3\",\"content\":[{\"nodeType\":\"text\",\"value\":\"API versions\",\"marks\":[],\"data\":{}}],\"data\":{}},{\"nodeType\":\"paragraph\",\"content\":[{\"nodeType\":\"text\",\"value\":\"The Marketing API is currently on version 3.0.\",\"marks\":[],\"data\":{}}],\"data\":{}},{\"nodeType\":\"paragraph\",\"content\":[{\"nodeType\":\"text\",\"value\":\"We also support a single-purpose Export API version 1.0, which provides API support for some of our \",\"marks\":[],\"data\":{}},{\"nodeType\":\"hyperlink\",\"content\":[{\"nodeType\":\"text\",\"value\":\"account export functionality\",\"marks\":[{\"type\":\"underline\"}],\"data\":{}}],\"data\":{\"uri\":\"https://mailchimp.com/help/export-back-up-data/\"}},{\"nodeType\":\"text\",\"value\":\". See the \",\"marks\":[],\"data\":{}},{\"nodeType\":\"hyperlink\",\"content\":[{\"nodeType\":\"text\",\"value\":\"Export API documentation\",\"marks\":[],\"data\":{}}],\"data\":{\"uri\":\"/marketing/docs/export-api/\"}},{\"nodeType\":\"text\",\"value\":\" for full details.\",\"marks\":[],\"data\":{}}],\"data\":{}},{\"nodeType\":\"paragraph\",\"content\":[{\"nodeType\":\"text\",\"value\":\"The first versions of the Marketing API, versions 1.1, 1.2, and 1.3, are no longer available.\",\"marks\":[],\"data\":{}}],\"data\":{}},{\"nodeType\":\"paragraph\",\"content\":[{\"nodeType\":\"text\",\"value\":\"The previous version 2.0 has not been shut off, but is deprecated and unsupported. We’ll announce shut off dates in advance, but we recommend migrating to version 3.0 since version 2.0 is not regularly tested or maintained.\",\"marks\":[],\"data\":{}}],\"data\":{}}]}","references":[]}},{"title":"API structure","forMarketersSidebar":null,"bodyRichText":{"raw":"{\"nodeType\":\"document\",\"data\":{},\"content\":[{\"nodeType\":\"paragraph\",\"content\":[{\"nodeType\":\"text\",\"value\":\"The Marketing API generally follows REST conventions, with some deviations.\",\"marks\":[],\"data\":{}},{\"nodeType\":\"text\",\"value\":\" \",\"marks\":[{\"type\":\"italic\"}],\"data\":{}}],\"data\":{}},{\"nodeType\":\"unordered-list\",\"content\":[{\"nodeType\":\"list-item\",\"content\":[{\"nodeType\":\"paragraph\",\"content\":[{\"nodeType\":\"text\",\"value\":\"Resources\",\"marks\":[{\"type\":\"italic\"}],\"data\":{}},{\"nodeType\":\"text\",\"value\":\" are typically nouns like \",\"marks\":[],\"data\":{}},{\"nodeType\":\"text\",\"value\":\"subscribers\",\"marks\":[{\"type\":\"code\"}],\"data\":{}},{\"nodeType\":\"text\",\"value\":\" or \",\"marks\":[],\"data\":{}},{\"nodeType\":\"text\",\"value\":\"campaigns\",\"marks\":[{\"type\":\"code\"}],\"data\":{}},{\"nodeType\":\"text\",\"value\":\".\",\"marks\":[],\"data\":{}}],\"data\":{}}],\"data\":{}},{\"nodeType\":\"list-item\",\"content\":[{\"nodeType\":\"paragraph\",\"content\":[{\"nodeType\":\"text\",\"value\":\"Subresources \",\"marks\":[{\"type\":\"italic\"}],\"data\":{}},{\"nodeType\":\"text\",\"value\":\"can be multiply nested under resources.\",\"marks\":[],\"data\":{}}],\"data\":{}}],\"data\":{}},{\"nodeType\":\"list-item\",\"content\":[{\"nodeType\":\"paragraph\",\"content\":[{\"nodeType\":\"text\",\"value\":\"Actions\",\"marks\":[{\"type\":\"italic\"}],\"data\":{}},{\"nodeType\":\"text\",\"value\":\" are usually represented by \",\"marks\":[],\"data\":{}},{\"nodeType\":\"hyperlink\",\"content\":[{\"nodeType\":\"text\",\"value\":\"HTTP methods\",\"marks\":[],\"data\":{}}],\"data\":{\"uri\":\"/marketing/docs/methods-parameters\"}},{\"nodeType\":\"text\",\"value\":\". Actions that do not correspond to HTTP methods are collected under an \",\"marks\":[],\"data\":{}},{\"nodeType\":\"text\",\"value\":\"actions/\",\"marks\":[{\"type\":\"code\"}],\"data\":{}},{\"nodeType\":\"text\",\"value\":\" subresource.\",\"marks\":[],\"data\":{}}],\"data\":{}}],\"data\":{}},{\"nodeType\":\"list-item\",\"content\":[{\"nodeType\":\"paragraph\",\"content\":[{\"nodeType\":\"text\",\"value\":\"Responses\",\"marks\":[{\"type\":\"italic\"}],\"data\":{}},{\"nodeType\":\"text\",\"value\":\" use the generic JSON content type.\",\"marks\":[],\"data\":{}}],\"data\":{}}],\"data\":{}}],\"data\":{}},{\"nodeType\":\"paragraph\",\"content\":[{\"nodeType\":\"text\",\"value\":\"We use the \",\"marks\":[],\"data\":{}},{\"nodeType\":\"hyperlink\",\"content\":[{\"nodeType\":\"text\",\"value\":\"OpenAPI Specification\",\"marks\":[],\"data\":{}}],\"data\":{\"uri\":\"https://swagger.io/specification/v2/\"}},{\"nodeType\":\"text\",\"value\":\" (formerly known as Swagger) to describe each endpoint. \",\"marks\":[],\"data\":{}},{\"nodeType\":\"hyperlink\",\"content\":[{\"nodeType\":\"text\",\"value\":\"The API self-description\",\"marks\":[{\"type\":\"underline\"}],\"data\":{}}],\"data\":{\"uri\":\"https://api.mailchimp.com/schema/3.0/Swagger.json?expand\"}},{\"nodeType\":\"text\",\"value\":\" also contains type information to help you error-check your requests.\",\"marks\":[],\"data\":{}}],\"data\":{}},{\"nodeType\":\"paragraph\",\"content\":[{\"nodeType\":\"text\",\"value\":\"The root url for the API is \",\"marks\":[],\"data\":{}},{\"nodeType\":\"text\",\"value\":\"https://<dc>.api.mailchimp.com/3.0/\",\"marks\":[{\"type\":\"code\"}],\"data\":{}},{\"nodeType\":\"text\",\"value\":\". The \",\"marks\":[],\"data\":{}},{\"nodeType\":\"text\",\"value\":\"<dc>\",\"marks\":[{\"type\":\"code\"}],\"data\":{}},{\"nodeType\":\"text\",\"value\":\" part of the URL corresponds to the data center for your account. For example, if the data center for your account is \",\"marks\":[],\"data\":{}},{\"nodeType\":\"text\",\"value\":\"us6\",\"marks\":[{\"type\":\"code\"}],\"data\":{}},{\"nodeType\":\"text\",\"value\":\", all API endpoints for your account are available relative to \",\"marks\":[],\"data\":{}},{\"nodeType\":\"text\",\"value\":\"https://us6.api.mailchimp.com/3.0/\",\"marks\":[{\"type\":\"code\"}],\"data\":{}},{\"nodeType\":\"text\",\"value\":\".\",\"marks\":[],\"data\":{}}],\"data\":{}},{\"nodeType\":\"paragraph\",\"content\":[{\"nodeType\":\"text\",\"value\":\"There are a few ways to find your data center. It’s the first part of the URL you see in the\",\"marks\":[],\"data\":{}},{\"nodeType\":\"hyperlink\",\"content\":[{\"nodeType\":\"text\",\"value\":\" \",\"marks\":[],\"data\":{}},{\"nodeType\":\"text\",\"value\":\"API keys section\",\"marks\":[{\"type\":\"underline\"}],\"data\":{}}],\"data\":{\"uri\":\"https://us1.admin.mailchimp.com/account/api/\"}},{\"nodeType\":\"text\",\"value\":\" of your account; if the URL is \",\"marks\":[],\"data\":{}},{\"nodeType\":\"text\",\"value\":\"https://us6.mailchimp.com/account/api/\",\"marks\":[{\"type\":\"code\"}],\"data\":{}},{\"nodeType\":\"text\",\"value\":\", then the data center subdomain is \",\"marks\":[],\"data\":{}},{\"nodeType\":\"text\",\"value\":\"us6\",\"marks\":[{\"type\":\"code\"}],\"data\":{}},{\"nodeType\":\"text\",\"value\":\". It’s also appended to your API key in the form key-dc; if your API key is \",\"marks\":[],\"data\":{}},{\"nodeType\":\"text\",\"value\":\"0123456789abcdef0123456789abcde-us6\",\"marks\":[{\"type\":\"code\"}],\"data\":{}},{\"nodeType\":\"text\",\"value\":\", then the data center subdomain is \",\"marks\":[],\"data\":{}},{\"nodeType\":\"text\",\"value\":\"us6\",\"marks\":[{\"type\":\"code\"}],\"data\":{}},{\"nodeType\":\"text\",\"value\":\". And finally, if you’re connecting via OAuth 2, you can find the data center associated with the token via the OAuth Metadata endpoint; for more information, see the \",\"marks\":[],\"data\":{}},{\"nodeType\":\"hyperlink\",\"content\":[{\"nodeType\":\"text\",\"value\":\"OAuth guide\",\"marks\":[{\"type\":\"underline\"}],\"data\":{}}],\"data\":{\"uri\":\"/marketing/guides/access-user-data-oauth-2/#implement-the-oauth-2-workflow-on-your-server\"}},{\"nodeType\":\"text\",\"value\":\".\",\"marks\":[],\"data\":{}}],\"data\":{}},{\"nodeType\":\"embedded-entry-block\",\"content\":[],\"data\":{\"target\":{\"sys\":{\"id\":\"5bE7eUYEjODaruiaY4AWCw\",\"type\":\"Link\",\"linkType\":\"Entry\"}}}},{\"nodeType\":\"paragraph\",\"content\":[{\"nodeType\":\"text\",\"value\":\"For more details on how to query Marketing API endpoints, see \",\"marks\":[],\"data\":{}},{\"nodeType\":\"hyperlink\",\"content\":[{\"nodeType\":\"text\",\"value\":\"Methods and Parameters\",\"marks\":[{\"type\":\"underline\"}],\"data\":{}}],\"data\":{\"uri\":\"/marketing/docs/methods-parameters/\"}},{\"nodeType\":\"text\",\"value\":\". For troubleshooting API calls, see the \",\"marks\":[],\"data\":{}},{\"nodeType\":\"hyperlink\",\"content\":[{\"nodeType\":\"text\",\"value\":\"Errors\",\"marks\":[{\"type\":\"underline\"}],\"data\":{}}],\"data\":{\"uri\":\"/marketing/docs/errors/\"}},{\"nodeType\":\"text\",\"value\":\" docs.\",\"marks\":[],\"data\":{}}],\"data\":{}}]}","references":[{"__typename":"ContentfulDeveloperGuideNote","contentful_id":"5bE7eUYEjODaruiaY4AWCw","tip":{"raw":"{\"nodeType\":\"document\",\"data\":{},\"content\":[{\"nodeType\":\"paragraph\",\"content\":[{\"nodeType\":\"text\",\"value\":\"Note\",\"marks\":[{\"type\":\"bold\"}],\"data\":{}},{\"nodeType\":\"text\",\"value\":\": You will see the \",\"marks\":[],\"data\":{}},{\"nodeType\":\"text\",\"value\":\"<dc>\",\"marks\":[{\"type\":\"code\"}],\"data\":{}},{\"nodeType\":\"text\",\"value\":\" placeholder or an actual data center subdomain in examples throughout this documentation. Either way, make sure to replace it in your code with the data center subdomain for your account, or your request may generate an error.\",\"marks\":[],\"data\":{}}],\"data\":{}}]}"}}]}},{"title":"Connecting to the API","forMarketersSidebar":null,"bodyRichText":{"raw":"{\"nodeType\":\"document\",\"data\":{},\"content\":[{\"nodeType\":\"paragraph\",\"content\":[{\"nodeType\":\"text\",\"value\":\"You can authenticate requests using either your API key or an OAuth access token, depending on your use case. You should use an API key if you’re writing code that tightly couples \",\"marks\":[],\"data\":{}},{\"nodeType\":\"text\",\"value\":\"your\",\"marks\":[{\"type\":\"italic\"}],\"data\":{}},{\"nodeType\":\"text\",\"value\":\" application data to \",\"marks\":[],\"data\":{}},{\"nodeType\":\"text\",\"value\":\"your\",\"marks\":[{\"type\":\"italic\"}],\"data\":{}},{\"nodeType\":\"text\",\"value\":\" Mailchimp account data; if you ever need to access \",\"marks\":[],\"data\":{}},{\"nodeType\":\"text\",\"value\":\"someone else’s\",\"marks\":[{\"type\":\"italic\"}],\"data\":{}},{\"nodeType\":\"text\",\"value\":\" Mailchimp account data, you should use OAuth 2.\",\"marks\":[],\"data\":{}}],\"data\":{}},{\"nodeType\":\"paragraph\",\"content\":[{\"nodeType\":\"text\",\"value\":\"For more information on the Mailchimp OAuth 2 flow, see \",\"marks\":[],\"data\":{}},{\"nodeType\":\"hyperlink\",\"content\":[{\"nodeType\":\"text\",\"value\":\"Access Data on Behalf of Other Users with OAuth 2\",\"marks\":[{\"type\":\"underline\"}],\"data\":{}}],\"data\":{\"uri\":\"/marketing/guides/access-user-data-oauth-2/\"}},{\"nodeType\":\"text\",\"value\":\".\",\"marks\":[],\"data\":{}}],\"data\":{}},{\"nodeType\":\"paragraph\",\"content\":[{\"nodeType\":\"text\",\"value\":\"If you’re integrating with the Marketing API using one of the \",\"marks\":[],\"data\":{}},{\"nodeType\":\"hyperlink\",\"content\":[{\"nodeType\":\"text\",\"value\":\"official client libraries\",\"marks\":[{\"type\":\"underline\"}],\"data\":{}}],\"data\":{\"uri\":\"/tools/\"}},{\"nodeType\":\"text\",\"value\":\", you won’t need to worry about the implementation details for authentication.\",\"marks\":[],\"data\":{}}],\"data\":{}},{\"nodeType\":\"heading-3\",\"content\":[{\"nodeType\":\"text\",\"value\":\"Authenticate with an API key or OAuth 2 token\",\"marks\":[],\"data\":{}}],\"data\":{}},{\"nodeType\":\"paragraph\",\"content\":[{\"nodeType\":\"text\",\"value\":\"API keys and OAuth 2 tokens can be used to make authenticated requests the same way. We’ll refer to both as tokens.\",\"marks\":[],\"data\":{}}],\"data\":{}},{\"nodeType\":\"paragraph\",\"content\":[{\"nodeType\":\"text\",\"value\":\"You can either use HTTP Basic Authentication or Bearer Authentication. \",\"marks\":[],\"data\":{}}],\"data\":{}},{\"nodeType\":\"paragraph\",\"content\":[{\"nodeType\":\"text\",\"value\":\"HTTP Basic Authentication:\",\"marks\":[],\"data\":{}}],\"data\":{}},{\"nodeType\":\"embedded-entry-block\",\"content\":[],\"data\":{\"target\":{\"sys\":{\"id\":\"1VirzMZEvmFkmBKaKGCsv5\",\"type\":\"Link\",\"linkType\":\"Entry\"}}}},{\"nodeType\":\"paragraph\",\"content\":[{\"nodeType\":\"text\",\"value\":\"Bearer Authentication:\",\"marks\":[],\"data\":{}}],\"data\":{}},{\"nodeType\":\"embedded-entry-block\",\"content\":[],\"data\":{\"target\":{\"sys\":{\"id\":\"2RsZLMPNPW6CjEZQUz5FL2\",\"type\":\"Link\",\"linkType\":\"Entry\"}}}},{\"nodeType\":\"heading-3\",\"content\":[{\"nodeType\":\"text\",\"value\":\"User API access\",\"marks\":[],\"data\":{}}],\"data\":{}},{\"nodeType\":\"paragraph\",\"content\":[{\"nodeType\":\"text\",\"value\":\"API authentication is tied to the user that created the API key or authorized the OAuth2 app. If the user is removed from the account, that authentication token will be revoked.\",\"marks\":[],\"data\":{}}],\"data\":{}},{\"nodeType\":\"paragraph\",\"content\":[{\"nodeType\":\"text\",\"value\":\"API access is also limited by the \",\"marks\":[],\"data\":{}},{\"nodeType\":\"hyperlink\",\"content\":[{\"nodeType\":\"text\",\"value\":\"user level (role)\",\"marks\":[{\"type\":\"underline\"}],\"data\":{}}],\"data\":{\"uri\":\"https://mailchimp.com/help/manage-user-levels-in-your-account/\"}},{\"nodeType\":\"text\",\"value\":\" of the authorizing user. The role is not fixed, and can change over time. You can check the role for an API key using the \",\"marks\":[],\"data\":{}},{\"nodeType\":\"hyperlink\",\"content\":[{\"nodeType\":\"text\",\"value\":\"API Root endpoint\",\"marks\":[{\"type\":\"underline\"}],\"data\":{}}],\"data\":{\"uri\":\"/marketing/api/root/\"}},{\"nodeType\":\"text\",\"value\":\", and see the restrictions in \",\"marks\":[],\"data\":{}},{\"nodeType\":\"hyperlink\",\"content\":[{\"nodeType\":\"text\",\"value\":\"this chart\",\"marks\":[{\"type\":\"underline\"}],\"data\":{}}],\"data\":{\"uri\":\"https://mailchimp.com/help/manage-user-levels-in-your-account/#Compare_user_level_permissions\"}},{\"nodeType\":\"text\",\"value\":\". Attempts to perform an API action that aren’t permitted for the role will return a \",\"marks\":[],\"data\":{}},{\"nodeType\":\"hyperlink\",\"content\":[{\"nodeType\":\"text\",\"value\":\"403 error\",\"marks\":[{\"type\":\"underline\"}],\"data\":{}}],\"data\":{\"uri\":\"/marketing/docs/errors/#error-glossary\"}},{\"nodeType\":\"text\",\"value\":\". When creating an API key or authorizing an app, we recommend using an admin user when possible. OAuth integrators may want to inform the user if the application won’t work at their user level.\",\"marks\":[],\"data\":{}}],\"data\":{}},{\"nodeType\":\"embedded-entry-block\",\"content\":[],\"data\":{\"target\":{\"sys\":{\"id\":\"4g2qQdIYDWnatGkSP4QbVq\",\"type\":\"Link\",\"linkType\":\"Entry\"}}}},{\"nodeType\":\"paragraph\",\"content\":[{\"nodeType\":\"text\",\"value\":\"\",\"marks\":[],\"data\":{}}],\"data\":{}}]}","references":[{"__typename":"ContentfulContentCodeSnippet","contentful_id":"1VirzMZEvmFkmBKaKGCsv5","title":"Basic HTTP Authentication","snippets":[{"highlightLanguage":"Bash","labelLanguage":null,"snippet":{"snippet":"curl --request GET \\\n--url 'https://<dc>.api.mailchimp.com/3.0/' \\\n--user 'anystring:TOKEN"}}]},{"__typename":"ContentfulContentCodeSnippet","contentful_id":"2RsZLMPNPW6CjEZQUz5FL2","title":"Bearer Authentication","snippets":[{"highlightLanguage":"Bash","labelLanguage":null,"snippet":{"snippet":"--url 'https://<dc>.api.mailchimp.com/3.0/' \\\n--header \"Authorization: Bearer <TOKEN>\""}}]},{"__typename":"ContentfulDeveloperGuideNote","contentful_id":"4g2qQdIYDWnatGkSP4QbVq","tip":{"raw":"{\"nodeType\":\"document\",\"data\":{},\"content\":[{\"nodeType\":\"paragraph\",\"content\":[{\"nodeType\":\"text\",\"value\":\"Note\",\"marks\":[{\"type\":\"bold\"}],\"data\":{}},{\"nodeType\":\"text\",\"value\":\": You are responsible for the security of API tokens; we recommend that you store them in a secure location on your server. Because of the potential security risks associated with exposing an API token, Mailchimp does not support client-side implementation of our API using CORS requests.\",\"marks\":[],\"data\":{}}],\"data\":{}}]}"}}]}},{"title":"API limits","forMarketersSidebar":null,"bodyRichText":{"raw":"{\"nodeType\":\"document\",\"data\":{},\"content\":[{\"nodeType\":\"paragraph\",\"content\":[{\"nodeType\":\"text\",\"value\":\"To improve the experience for all our users, we impose some limits on API requests. These limits prevent a single user from making too many expensive calls at once. Exceeding the limits can result in your API access being disabled, so be cognizant of the quantity and complexity of your requests. Currently there are no options to raise the limit on a per-customer basis.\",\"marks\":[],\"data\":{}}],\"data\":{}},{\"nodeType\":\"heading-3\",\"content\":[{\"nodeType\":\"text\",\"value\":\"Throttling\",\"marks\":[],\"data\":{}}],\"data\":{}},{\"nodeType\":\"paragraph\",\"content\":[{\"nodeType\":\"text\",\"value\":\"The Marketing API has a limit of 10 simultaneous connections. You’ll receive a \",\"marks\":[],\"data\":{}},{\"nodeType\":\"hyperlink\",\"content\":[{\"nodeType\":\"text\",\"value\":\"429 error\",\"marks\":[],\"data\":{}}],\"data\":{\"uri\":\"/marketing/docs/errors/#error-glossary\"}},{\"nodeType\":\"text\",\"value\":\" if you reach the limit. At exceptionally high volumes, you may receive an HTTP 429 or 403 without a JSON body.\",\"marks\":[],\"data\":{}}],\"data\":{}},{\"nodeType\":\"paragraph\",\"content\":[{\"nodeType\":\"text\",\"value\":\"We recommend that you cache frequently accessed values that do not change often in your application’s data store. This will prevent your application from bumping up against the throttling limitations and will likely provide faster access to that data.\",\"marks\":[],\"data\":{}}],\"data\":{}},{\"nodeType\":\"heading-3\",\"content\":[{\"nodeType\":\"text\",\"value\":\"Stream timeouts\",\"marks\":[],\"data\":{}}],\"data\":{}},{\"nodeType\":\"paragraph\",\"content\":[{\"nodeType\":\"text\",\"value\":\"The Marketing API has a 120-second timeout on API calls. You may see this type of timeout after you’ve made a network socket connection and are already sending and receiving data.\",\"marks\":[],\"data\":{}}],\"data\":{}},{\"nodeType\":\"paragraph\",\"content\":[{\"nodeType\":\"text\",\"value\":\"Response times are dependent on the complexity of your request and the general load across Mailchimp. Some endpoints in the Marketing API return values that are large and slow to calculate. Once you know what data you need, use the \",\"marks\":[],\"data\":{}},{\"nodeType\":\"hyperlink\",\"content\":[{\"nodeType\":\"text\",\"value\":\"pagination and partial response capabilities\",\"marks\":[],\"data\":{}}],\"data\":{\"uri\":\"/marketing/docs/methods-parameters/#query-string-parameters\"}},{\"nodeType\":\"text\",\"value\":\" to request only what is essential to you. \",\"marks\":[],\"data\":{}}],\"data\":{}},{\"nodeType\":\"embedded-entry-block\",\"content\":[],\"data\":{\"target\":{\"sys\":{\"id\":\"3lkh6T4QX9Ws0EJa8AfeSu\",\"type\":\"Link\",\"linkType\":\"Entry\"}}}},{\"nodeType\":\"paragraph\",\"content\":[{\"nodeType\":\"text\",\"value\":\"\",\"marks\":[],\"data\":{}}],\"data\":{}}]}","references":[{"__typename":"ContentfulDeveloperGuideNote","contentful_id":"3lkh6T4QX9Ws0EJa8AfeSu","tip":{"raw":"{\"nodeType\":\"document\",\"data\":{},\"content\":[{\"nodeType\":\"paragraph\",\"content\":[{\"nodeType\":\"text\",\"value\":\"Note\",\"marks\":[{\"type\":\"bold\"}],\"data\":{}},{\"nodeType\":\"text\",\"value\":\": If you’re regularly seeing issues with timeouts and are unable to optimize your requests using pagination, you might consider \",\"marks\":[],\"data\":{}},{\"nodeType\":\"hyperlink\",\"content\":[{\"nodeType\":\"text\",\"value\":\"sending long-running requests to the Batch endpoint\",\"marks\":[{\"type\":\"underline\"}],\"data\":{}}],\"data\":{\"uri\":\"/marketing/guides/run-async-requests-batch-endpoint\"}},{\"nodeType\":\"text\",\"value\":\".\",\"marks\":[],\"data\":{}}],\"data\":{}}]}"}}]}}]},"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":[]}]}},"pageContext":{"product":"marketing","productLink":"Marketing","productPages":["landing","guide","docs","reference"],"pageVariant":"docs","withGuideData":false,"withDocData":true,"withRefData":false,"withLandingPageData":false,"docSlug":"fundamentals"}},"staticQueryHashes":["1207002660","1376854140","279774122","302783970","3936069583"]}