Errors Documentation | Mailchimp Developer

相关文章推荐

才高八斗的香蕉 · Manage read replicas ...· 3 年前 ·

叛逆的墨镜 · Newtonsoft中JArray ...· 3 年前 ·

仗义的火腿肠 · (转）jmeter ...· 3 年前 ·

温柔的春卷 · CSS展开图标旋转180度 - 掘金· 3 年前 ·

</noscript><div id="___gatsby"><div style="outline:none" tabindex="-1" id="gatsby-focus-wrapper"><header data-module-id="header" data-tracking-event="navigation"><div class="headroom-wrapper"><div class="headroom headroom--unfixed"><div class="Header-module--header-wrapper--JvjUp"><div class="Header-module--header--3ZHti"><a class="ga_topNav Header-module--desktop-logo-wrap--auhH2" data-component-id="logo_link" data-header="Mailchimp Developer" data-subheader="Mailchimp Developer" data-enable-tracking="true" href="/developer/"><img class="Header-module--logo--26O7V" src="//images.ctfassets.net/cxsachrr7h0p/4bV5cUR8fSfjlgmTrXNk3X/b37d73ebda118235c8e768b2f2075008/mc-logo-two-toned__2_.svg" alt="Mailchimp Developer Logo"/><img class="Header-module--unpinned-hidden--2dZcb" src="//images.ctfassets.net/cxsachrr7h0p/5m51J4r6wQwEFM9AGCP69Q/b5100daf303436590c6e0d182c42e588/Wordmark.svg" alt="Mailchimp Developer Wordmark"/></a><div class="Header-module--flex-container--3JjLi Header-module--unpinned-hidden--2dZcb"><button class="Header-module--mobile-menu-btn--1-jCt"><svg alt="Show site navigation" width="24" height="24" viewbox="0 0 24 24" fill="none"><path d="M3 18H21V16H3V18ZM3 13H21V11H3V13ZM3 6V8H21V6H3Z" fill="#EFEEEA"/></svg></button><div class="Header-module--nav-wrap--3J5tt"><nav id="header-nav-links" class="Header-module--nav--UY99G"><a class="SkipLink-module--skip-link--2geKh" href="#main-content">Skip to main content</a><span class="ga_topNav Header-module--nav-link--2yR-8 Header-module--products-link--1-YyQ">Products</span><div class="Header-module--product-nav-wrapper--ThX1U Header-module--product-nav-wrapper-mobile--JV5dJ"><div class="containers-module--container-outer--1Zjim Header-module--product-nav--3itdV"><ul class="Header-module--products-wrap--36vQQ"><li class="Header-module--product--1WwIS"><h2 class="Header-module--product-name--2ROpV"><a data-component-id="product_headline_link" data-enable-tracking="true" href="/developer/marketing/">Mailchimp Marketing API</a></h2><p class="typography-module--body-copy-small--2ESDb Header-module--product-copy--1Ax9y">Power timely, relevant marketing campaigns with custom data pulled directly from your app.</p></li><li class="Header-module--product--1WwIS"><h2 class="Header-module--product-name--2ROpV"><a data-component-id="product_headline_link" data-enable-tracking="true" href="/developer/transactional/">Mailchimp Transactional Email</a></h2><p class="typography-module--body-copy-small--2ESDb Header-module--product-copy--1Ax9y">Send targeted and event-driven messages to anyone, fast—with best-in-class deliverability.</p></li><li class="Header-module--product--1WwIS"><h2 class="Header-module--product-name--2ROpV"><a data-component-id="product_headline_link" data-enable-tracking="true" href="/developer/open-commerce/">Mailchimp Open Commerce</a></h2><p class="typography-module--body-copy-small--2ESDb Header-module--product-copy--1Ax9y">Control your commerce future with a modular, API-first commerce stack.</p></li></ul></div></div><a class="ga_topNav Header-module--nav-link--2yR-8" data-header="Tools" data-subheader="Tools" data-ctaposition="3" data-enable-tracking="true" href="/developer/tools/">Tools</a><a class="ga_topNav Header-module--nav-link--2yR-8" data-header="Release Notes" data-subheader="Release Notes" data-ctaposition="4" data-enable-tracking="true" href="/developer/release-notes/">Release Notes</a><a class="ga_topNav Header-module--nav-link--2yR-8" data-header="Blog" data-subheader="Blog" data-ctaposition="4" data-enable-tracking="true" href="/developer/blog/">Blog</a></nav></div><a id="header-mobile-logo" class="ga_topNav Header-module--mobile-logo--3yFIs" data-component-id="header_mobile_logo" data-header="Mailchimp Developer" data-subheader="Mailchimp Developer" data-enable-tracking="true" href="/developer/"><img src="//images.ctfassets.net/cxsachrr7h0p/3qVv4PCi3ZdnX5E1zqUsZE/52729a3733e82d3bd3484bc4aa9bf62d/mc-logo-mobile-light.svg" alt="Mailchimp Developer Homepage"/></a><div class="Search-module--search-wrap--1m82F Search-module--dark-theme--r0b9m"><label class="Search-module--search-bar--gMGX2"><input aria-owns="search-input-results" aria-activedescendant="" aria-roledescription="Search Mailchimp Developer" class="Search-module--search-input--2EBPA" aria-label="Search Developer" placeholder="Search Developer"/></label></div></div></div></div></div></div></header><main id="main-content" class=""><div class="Layout-module--header-spacer--2AkvN"/><div class="ProductLayout-module--product-layout--35aVk _16-col-grid-module--col-16-wrap--2rUb-"><div class="_16-col-grid-module--left-col--2w-FA _16-col-grid-module--mobile-sticky--hpInc _16-col-grid-module--nudge-sticky-menu--3yovg"><div data-module-id="left_sidebar" class="LeftSidebar-module--navbar--19dp0"><a class="SkipLink-module--skip-link--2geKh" href="#docs-content">Skip navigation</a><h3 class="LeftSidebar-module--title--RzyJh LeftSidebar-module--title-text--MUx1k LeftSidebar-module--desktop--2Leic typography-module--code-copy--34_zK left-sidebar-title-text">Mailchimp Marketing API</h3><div id="left-col-scrollbar-container" class="LeftSidebar-module--container--3N9KH LeftSidebar-module--mobile-menu--IYFNE"><span class="LeftSidebar-module--overflow-gradient--2XPOi LeftSidebar-module--top--1zaLb"/><button class="global-container-outer-mobile containers-module--container-outer-mobile--3wPd0 LeftSidebar-module--title--RzyJh LeftSidebar-module--mobile--3772s"><span class="global-container-inner-mobile containers-module--container-inner-mobile--1sCy7"><span class="LeftSidebar-module--title-text-wrapper--3vPpg"><span class="typography-module--code-copy--34_zK LeftSidebar-module--title-text--MUx1k left-sidebar-title-text">Mailchimp Marketing API</span><span class="LeftSidebar-module--subtitle-text--1bJNq typography-module--body-copy--vV_fZ">Documentation</span></span><svg aria-hidden="true" alt="carat icon" class="LeftSidebar-module--icon-carat--1j2fL" width="12" height="8" viewbox="0 0 12 8" fill="none"><path d="M1.41 0.589966L6 5.16997L10.59 0.589966L12 1.99997L6 7.99997L0 1.99997L1.41 0.589966Z" fill="#E7B75F"/></svg></span></button><div class="global-container-outer-mobile containers-module--container-outer-mobile--3wPd0 LeftSidebar-module--children-container--3wAxT LeftSidebar-module--mobile-hidden--Co58V"><div class="global-container-inner-mobile containers-module--container-inner-mobile--1sCy7"><ul><li><a class="typography-module--body-copy--vV_fZ ProductLayoutLinks-module--subnav-heading--1_BRd" data-enable-tracking="true" href="/developer/marketing/">Overview</a></li><li><a class="typography-module--body-copy--vV_fZ ProductLayoutLinks-module--subnav-heading--1_BRd" data-enable-tracking="true" href="/developer/marketing/guides/quick-start/">Guides</a></li><li><nav class="ProductNavbar-module--product-link-group--Zn-md" data-module-id="navbar_section"><div class="ProductNavbar-module--product--3Srip"><button data-component-id="navbar_toggle_button" class="ProductNavbar-module--toggle-btn--24bds"><span class="typography-module--body-copy--vV_fZ ProductNavbar-module--heading--2yzRS ProductNavbar-module--heading--active--3GWSx">Documentation</span></button></div><ul><li class="ProductNavbar-module--product-item--t35LX"><div class="ProductNavbar-module--link-wrap--2dmlx"><a class="ga_leftNav ProductNavbar-module--product-link--U6pSM" data-component-id="navbar_section_link" data-header="marketing" data-subheader="Fundamentals" data-ctaposition="1" data-enable-tracking="true" href="/developer/marketing/docs/fundamentals/">Fundamentals</a></div></li><li class="ProductNavbar-module--product-item--t35LX"><div class="ProductNavbar-module--link-wrap--2dmlx"><a class="ga_leftNav ProductNavbar-module--product-link--U6pSM" data-component-id="navbar_section_link" data-header="marketing" data-subheader="Methods and Parameters" data-ctaposition="2" data-enable-tracking="true" href="/developer/marketing/docs/methods-parameters/">Methods and Parameters</a></div></li><li class="ProductNavbar-module--product-item--t35LX"><div class="ProductNavbar-module--link-wrap--2dmlx"><a class="ga_leftNav ProductNavbar-module--product-link--U6pSM" data-component-id="navbar_section_link" data-header="marketing" data-subheader="Merge Fields" data-ctaposition="3" data-enable-tracking="true" href="/developer/marketing/docs/merge-fields/">Merge Fields</a></div></li><li class="ProductNavbar-module--product-item--t35LX"><div class="ProductNavbar-module--link-wrap--2dmlx"><a class="ga_leftNav ProductNavbar-module--product-link--U6pSM" data-component-id="navbar_section_link" data-header="marketing" data-subheader="Alternative Schemas" data-ctaposition="4" data-enable-tracking="true" href="/developer/marketing/docs/alternative-schemas/">Alternative Schemas</a></div></li><li class="ProductNavbar-module--product-item--t35LX"><div class="ProductNavbar-module--link-wrap--2dmlx"><a class="ga_leftNav ProductNavbar-module--product-link--U6pSM" data-component-id="navbar_section_link" data-header="marketing" data-subheader="E-Commerce" data-ctaposition="5" data-enable-tracking="true" href="/developer/marketing/docs/e-commerce/">E-Commerce</a></div></li><li class="ProductNavbar-module--product-item--t35LX"><div class="ProductNavbar-module--link-wrap--2dmlx"><a class="ga_leftNav ProductNavbar-module--product-link--U6pSM" data-component-id="navbar_section_link" data-header="marketing" data-subheader="Account Exports" data-ctaposition="6" data-enable-tracking="true" href="/developer/marketing/docs/account-exports/">Account Exports</a></div></li><li class="ProductNavbar-module--product-item--t35LX"><div class="ProductNavbar-module--link-wrap--2dmlx"><a class="ga_leftNav ProductNavbar-module--product-link--U6pSM" data-component-id="navbar_section_link" data-header="marketing" data-subheader="Integrations" data-ctaposition="7" data-enable-tracking="true" href="/developer/marketing/docs/integrations/">Integrations</a></div></li><li class="ProductNavbar-module--product-item--t35LX"><div class="ProductNavbar-module--link-wrap--2dmlx"><a class="ga_leftNav ProductNavbar-module--product-link--U6pSM" data-component-id="navbar_section_link" data-header="marketing" data-subheader="Mobile SDK" data-ctaposition="8" data-enable-tracking="true" href="/developer/marketing/docs/mobile-sdk/">Mobile SDK</a></div></li><li class="ProductNavbar-module--product-item--t35LX"><div class="ProductNavbar-module--link-wrap--2dmlx ProductNavbar-module--active-link-wrap--1kuvs"><a aria-current="page" class="ga_leftNav ProductNavbar-module--product-link--U6pSM ProductNavbar-module--active--2m5Dq" data-component-id="navbar_section_link" data-header="marketing" data-subheader="Errors" data-ctaposition="9" data-enable-tracking="true" href="/developer/marketing/docs/errors/">Errors</a></div><ul class="ProductNavbar-module--anchors--21QCT"><li class="ProductNavbar-module--product-item--t35LX"><div class="ProductNavbar-module--link-wrap--2dmlx"><a class="ProductNavbar-module--product-link--U6pSM ga_leftNav" data-component-id="navbar_section_anchors" data-header="Errors" data-subheader="The basics" data-ctaposition="1" href="#the-basics">The basics</a></div></li><li class="ProductNavbar-module--product-item--t35LX"><div class="ProductNavbar-module--link-wrap--2dmlx"><a class="ProductNavbar-module--product-link--U6pSM ga_leftNav" data-component-id="navbar_section_anchors" data-header="Errors" data-subheader="Error format" data-ctaposition="2" href="#error-format">Error format</a></div></li><li class="ProductNavbar-module--product-item--t35LX"><div class="ProductNavbar-module--link-wrap--2dmlx"><a class="ProductNavbar-module--product-link--U6pSM ga_leftNav" data-component-id="navbar_section_anchors" data-header="Errors" data-subheader="Common causes" data-ctaposition="3" href="#common-causes">Common causes</a></div></li><li class="ProductNavbar-module--product-item--t35LX"><div class="ProductNavbar-module--link-wrap--2dmlx"><a class="ProductNavbar-module--product-link--U6pSM ga_leftNav" data-component-id="navbar_section_anchors" data-header="Errors" data-subheader="Error glossary" data-ctaposition="4" href="#error-glossary">Error glossary</a></div></li></ul></li></ul></nav></li><li><a class="typography-module--body-copy--vV_fZ ProductLayoutLinks-module--subnav-heading--1_BRd" data-enable-tracking="true" href="/developer/marketing/api/">API Reference</a></li></ul></div></div><span class="LeftSidebar-module--overflow-gradient--2XPOi LeftSidebar-module--bottom--2aZJ3"/></div></div></div><div class="_16-col-grid-module--right-col--1Z2qU right-col" id="docs-content" data-module-id="product_context"><div class="containers-module--container-outer-mobile--3wPd0 ProductContentPage-module--content-wrap--8zj04"><div class="containers-module--container-inner-mobile--1sCy7"><h1 class="typography-module--primary-heading--3wF-z">Errors</h1><div class="content-baseline-module--content-baseline--Q6vdC"><div class="ProductContentBase-module--section-wrap--29qHT content-baseline-module--content-baseline--Q6vdC"><h2 class="typography-module--body-heading--2kIje ProductContentBase-module--section-heading--4dCbz"><a data-component-id="anchor" href="#the-basics" class="Anchor-module--anchor--DMN0D anchor" id="the-basics"/><a data-component-id="content_item_heading" href="#the-basics">The basics</a></h2><div class="RichText-module--rich-text--2vnh9"><p>The Mailchimp Marketing API will return a variety of errors if anything goes wrong with your API calls. Every error has an HTTP status code, and will also return an error type and brief explanation when the error is triggered. This documentation provides additional explanations of these errors and guidance on how to avoid them.</p><p>When you use any API, keep in mind that errors and exceptions (e.g., server connection problems or outages) are rare, but they do happen. To make sure that your integration is as reliable as it can be, you should always watch for errors and exceptions. </p><p>If your API call returns an error, log the call in as much detail as you can. If you need to <a class="ga_outbound" data-ctacategory="outbound" data-type="inline" data-url="mailto:apihelp@mailchimp.com" rel="noopener noreferrer" target="_blank" href="mailto:apihelp@mailchimp.com" data-enable-tracking="true"><u>contact support</u></a>, we recommend including the complete request you’re trying to make, the error code, and the response you’re receiving so they can help as quickly as possible. </p></div></div><div class="ProductContentBase-module--section-wrap--29qHT content-baseline-module--content-baseline--Q6vdC"><h2 class="typography-module--body-heading--2kIje ProductContentBase-module--section-heading--4dCbz"><a data-component-id="anchor" href="#error-format" class="Anchor-module--anchor--DMN0D anchor" id="error-format"/><a data-component-id="content_item_heading" href="#error-format">Error format</a></h2><div class="RichText-module--rich-text--2vnh9"><p>We expose API errors in two ways: standard HTTP response codes and human-readable messages in JSON format. </p><p>Here’s an HTTP 405 error in both formats:</p><div class="ContentSnippet-module--content-snippet--2sSiq"><div class="CodeSnippet-module--code-snippet--24KPz"><div class="CodeSnippet-module--header--_IR8C"><h3 class="CodeSnippet-module--header-title--3Nzdh">Error – HTTP Response</h3><div class="CodeSnippet-module--header-buttons--3t-nk"><span class="CodeSnippet-module--language-selected--z7o-3">Plain Text</span><div class="CodeSnippet-module--copy-wrap--2Xuuc"><button class="CodeSnippet-module--copy-snippet--2HJqT" data-component-id="copy_code" title="Copy"><span class="CodeSnippet-module--copy-snippet-icon-wrap--25cEG"><svg width="24" height="24" viewbox="0 0 24 24" fill="none"><path d="M18 4L4 4V18H2L2 2L18 2V4Z" fill="currentColor"/><path fill-rule="evenodd" clip-rule="evenodd" d="M6 22V6H22V22H6ZM8 8H20V20H8V8Z" fill="currentColor"/></svg></span></button></div></div></div><div class="CodeSnippet-module--snippets-wrap--725CX"><pre class="prismjs CodeSnippet-module--snippets--2rR99"><code class="language-text">HTTP/1.1 405 Method Not Allowed Server: nginx Content-Type: application/problem+json; charset=utf-8 Content-Length: 253 X-Request-Id: a1efb240-f8d8-40fe-a680-c3a5619a42e9 Link: &lt;https://us2.api.mailchimp.com/schema/3.0/ProblemDetailDocument.json&gt;; rel="describedBy" Date: Thu, 17 Sep 2015 19:02:28 GMT Connection: keep-alive Set-Cookie: _AVESTA_ENVIRONMENT=prod; path=/</code></pre></div></div></div><div class="ContentSnippet-module--content-snippet--2sSiq"><div class="CodeSnippet-module--code-snippet--24KPz"><div class="CodeSnippet-module--header--_IR8C"><h3 class="CodeSnippet-module--header-title--3Nzdh">Error – JSON</h3><div class="CodeSnippet-module--header-buttons--3t-nk"><span class="CodeSnippet-module--language-selected--z7o-3">JSON</span><div class="CodeSnippet-module--copy-wrap--2Xuuc"><button class="CodeSnippet-module--copy-snippet--2HJqT" data-component-id="copy_code" title="Copy"><span class="CodeSnippet-module--copy-snippet-icon-wrap--25cEG"><svg width="24" height="24" viewbox="0 0 24 24" fill="none"><path d="M18 4L4 4V18H2L2 2L18 2V4Z" fill="currentColor"/><path fill-rule="evenodd" clip-rule="evenodd" d="M6 22V6H22V22H6ZM8 8H20V20H8V8Z" fill="currentColor"/></svg></span></button></div></div></div><div class="CodeSnippet-module--snippets-wrap--725CX"><pre class="prismjs CodeSnippet-module--snippets--2rR99"><code class="language-json">{ "type": "https://mailchimp.com/developer/marketing/docs/errors/", "title": "Method Not Allowed", "status": 405, "detail": "The requested method and resource are not compatible. See the Allow header for this resource's available methods.", "instance": "3b4dcb40-0b6b-4820-bfaa-41267b3826ea" }</code></pre></div></div></div><p/></div></div><div class="ProductContentBase-module--section-wrap--29qHT content-baseline-module--content-baseline--Q6vdC"><h2 class="typography-module--body-heading--2kIje ProductContentBase-module--section-heading--4dCbz"><a data-component-id="anchor" href="#common-causes" class="Anchor-module--anchor--DMN0D anchor" id="common-causes"/><a data-component-id="content_item_heading" href="#common-causes">Common causes</a></h2><div class="RichText-module--rich-text--2vnh9"><p>4xx status codes suggest a bad request. If you receive a 4xx response, the error glossary below offers more context to help you troubleshoot. </p><p>5xx status codes suggest a problem on Mailchimp’s end. If you receive a 5xx error, we recommend checking <a class="ga_outbound" data-ctacategory="outbound" data-type="inline" data-url="https://twitter.com/mailchimpstatus" rel="noopener noreferrer" target="_blank" href="https://twitter.com/mailchimpstatus" data-enable-tracking="true">@MailchimpStatus</a> on Twitter to see if we are experiencing any system-wide issues. </p><p>If you receive an HTTP 502 error with an HTML body, your request may have timed out and been closed by our CDN. Contact support for help resolving.</p><p>To test error handling, you can trigger errors yourself by sending an <code>X-Trigger-Error</code> header with the name of the error. For example, sending a value of <code>APIKeyMissing</code> in the <code>X-Trigger-Error</code> header will trigger a 401 error. </p></div></div><div class="ProductContentBase-module--section-wrap--29qHT content-baseline-module--content-baseline--Q6vdC"><h2 class="typography-module--body-heading--2kIje ProductContentBase-module--section-heading--4dCbz"><a data-component-id="anchor" href="#error-glossary" class="Anchor-module--anchor--DMN0D anchor" id="error-glossary"/><a data-component-id="content_item_heading" href="#error-glossary">Error glossary</a></h2><div class="RichText-module--rich-text--2vnh9"><p><b/></p><div class="content-baseline-module--content-baseline--Q6vdC"><table><thead><tr><th>Error</th><th>Description</th></tr></thead><tbody><tr><td><div class="RichText-module--rich-text--2vnh9"><p>400</p></div></td><td><div class="RichText-module--rich-text--2vnh9"><p>There are several different error titles returned for 400 errors, which will return an explanation in the “detail” field. Some of the most notable include: </p><p><b>Bad Request </b>This is the generic error type for not being able to process the request, and will generally contain an explanation in the message.</p><p><b>Invalid Resource </b>The submitted POST body failed our input validation. This error may include an additional “errors” property, with a list of the validation issues.</p><p><b>Invalid Action: The action requested was not valid for this resource. </b>Returned when you try to access an action on a resource that doesn’t support that action.</p><p><b>JSON Parse Exception</b> The JSON sent in the request body is not valid JSON.</p></div></td></tr><tr><td><div class="RichText-module--rich-text--2vnh9"><p>401</p></div></td><td><div class="RichText-module--rich-text--2vnh9"><p><b>API Key Invalid </b>The API key is either invalid or disabled; there will be more information in the “detail”. For help authenticating with the Marketing API, see the <a class="ga_outbound" data-ctacategory="outbound" data-type="inline" data-url="https://mailchimp.com/developer/marketing/guides/quick-start/#generate-your-api-key" rel="noopener noreferrer" target="_blank" href="https://mailchimp.com/developer/marketing/guides/quick-start/#generate-your-api-key" data-enable-tracking="true"><u>Quick Start</u></a> guide.</p></div></td></tr><tr><td><div class="RichText-module--rich-text--2vnh9"><p>403</p></div></td><td><div class="RichText-module--rich-text--2vnh9"><p><b>Forbidden </b>Either the user who created the API key no longer has access to the account, or their <a class="ga_outbound" data-ctacategory="outbound" data-type="inline" data-url="https://mailchimp.com/help/manage-user-levels-in-your-account/" rel="noopener noreferrer" target="_blank" href="https://mailchimp.com/help/manage-user-levels-in-your-account/" data-enable-tracking="true"><u>user level</u></a> doesn’t allow access to the endpoint; there will be more information in the “detail”. For user levels, the role of the API key is returned from the <a class="ga_outbound" data-ctacategory="outbound" data-type="inline" data-url="/marketing/api/root/" href="/developer/marketing/api/root/" data-enable-tracking="true"><u>Root endpoint</u></a>. Note that a user’s level can change, changing the access of the API key as well.</p><p><b>User Disabled: This account has been deactivated. </b>The Mailchimp account is deactivated. Contact <a class="ga_outbound" data-ctacategory="outbound" data-type="inline" data-url="https://mailchimp.com/help/mailchimp-support-options/" rel="noopener noreferrer" target="_blank" href="https://mailchimp.com/help/mailchimp-support-options/" data-enable-tracking="true"><u>support</u></a> if you need more help.</p><p><b>Authorization Failure: User does not have access to the requested operation </b>Your account’s pricing plan may not permit access to a feature; upgrading the account’s plan may fix these errors.</p></div></td></tr><tr><td><div class="RichText-module--rich-text--2vnh9"><p>404</p></div></td><td><div class="RichText-module--rich-text--2vnh9"><p><b>Resource Not Found: The requested resource could not be found. </b>Either no object exists with the ID provided in the path, or the path is incorrect.</p></div></td></tr><tr><td><div class="RichText-module--rich-text--2vnh9"><p>405</p></div></td><td><div class="RichText-module--rich-text--2vnh9"><p><b>Method Not Allowed