openapi-directory/api/mailchimp.com.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","servers":[{"url":"https://server.api.mailchimp.com/3.0"}],"info":{"contact":{"email":"apihelp@mailchimp.com","name":"Mailchimp API Support"},"title":"Mailchimp Marketing API","version":"3.0.55","x-apisguru-categories":["messaging"],"x-logo":{"url":"https://eep.io/images/yzco4xsimv0y/10ZRu9hZ1QQ5u1QQMu7qN1/57f679c6e8f6dd60a01d54f870fae6b7/MC_50-50_-_Brand_Assets_03.png?w=980&fm=webp&q=70"},"x-origin":[{"format":"swagger","url":"https://api.mailchimp.com/schema/3.0/Swagger.json?expand","version":"2.0"}],"x-permalink":"https://github.com/mailchimp/mailchimp-client-lib-codegen/blob/main/spec/marketing.json","x-providerName":"mailchimp.com"},"externalDocs":{"description":"Learn more with the full Mailchimp API documentation.","url":"https://mailchimp.com/developer/marketing/"},"security":[{"basicAuth":[]}],"paths":{"/":{"get":{"deprecated":false,"description":"Get links to all other resources available in the API.","operationId":"getRoot","parameters":[{"description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","explode":false,"in":"query","name":"fields","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form","x-title":"Fields"},{"description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","explode":false,"in":"query","name":"exclude_fields","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form","x-title":"Exclude Fields"}],"responses":{"200":{"content":{"application/json":{"schema":{"description":"The API root resource links to all other resources available in the API.","properties":{"_links":{"description":"A list of link types and descriptions for the API schema documents.","items":{"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","properties":{"href":{"description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.","readOnly":true,"title":"Href","type":"string"},"method":{"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"readOnly":true,"title":"Method","type":"string"},"rel":{"description":"As with an HTML 'rel' attribute, this describes the type of link.","readOnly":true,"title":"Rel","type":"string"},"schema":{"description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.","readOnly":true,"title":"Schema","type":"string"},"targetSchema":{"description":"For GETs, this is a URL representing the schema that the response should conform to.","readOnly":true,"title":"Target Schema","type":"string"}},"title":"Resource Link","type":"object"},"readOnly":true,"title":"Links","type":"array"},"account_id":{"description":"The Mailchimp account ID.","readOnly":true,"title":"Account ID","type":"string"},"account_industry":{"description":"The user-specified industry associated with the account.","readOnly":true,"title":"Account Industry","type":"string"},"account_name":{"description":"The name of the account.","readOnly":true,"title":"Account Name","type":"string"},"account_timezone":{"description":"The timezone currently set for the account.","readOnly":true,"title":"Account Timezone","type":"string"},"avatar_url":{"description":"URL of the avatar for the user.","readOnly":true,"title":"Avatar URL","type":"string"},"contact":{"description":"Information about the account contact.","properties":{"addr1":{"description":"The street address for the account contact.","readOnly":true,"title":"Address Line 1","type":"string"},"addr2":{"description":"The street address for the account contact.","readOnly":true,"title":"Address Line 2","type":"string"},"city":{"description":"The city for the account contact.","readOnly":true,"title":"City","type":"string"},"company":{"description":"The company name for the account.","readOnly":true,"title":"Company","type":"string"},"country":{"description":"The country for the account contact.","readOnly":true,"title":"Country","type":"string"},"state":{"description":"The state for the account contact.","readOnly":true,"title":"State","type":"string"},"zip":{"description":"The zip code for the account contact.","readOnly":true,"title":"Zip Code","type":"string"}},"readOnly":true,"title":"Account Contact","type":"object"},"email":{"description":"The account email address.","readOnly":true,"title":"Account Email","type":"string"},"first_name":{"description":"The first name tied to the account.","readOnly":true,"title":"First Name","type":"string"},"first_payment":{"description":"Date of first payment for monthly plans.","example":"2025-06-15T13:50:44.685Z","format":"date-time","readOnly":true,"title":"First Payment","type":"string"},"industry_stats":{"description":"The [average campaign statistics](https://mailchimp.com/resources/research/email-marketing-benchmarks/?utm_source=mc-api&utm_medium=docs&utm_campaign=apidocs) for all campaigns in the account's specified industry.","properties":{"bounce_rate":{"description":"The average bounce rate for all campaigns in the account's specified industry.","readOnly":true,"title":"Bounce Rate","type":"number"},"click_rate":{"description":"The average unique click rate for all campaigns in the account's specified industry.","readOnly":true,"title":"Click Rate","type":"number"},"open_rate":{"description":"The average unique open rate for all campaigns in the account's specified industry.","readOnly":true,"title":"Open Rate","type":"number"}},"readOnly":true,"title":"Industry Stats","type":"object"},"last_login":{"description":"The date and time of the last login for this account in ISO 8601 format.","format":"date-time","readOnly":true,"title":"Last Login Date","type":"string"},"last_name":{"description":"The last name tied to the account.","readOnly":true,"title":"Last Name","type":"string"},"login_id":{"description":"The ID associated with the user who owns this API key. If you can login to multiple accounts, this ID will be the same for each account.","readOnly":true,"title":"Login ID","type":"string"},"member_since":{"description":"The date and time that the account was created in ISO 8601 format.","example":"2025-06-15T13:50:44.685Z","format":"date-time","readOnly":true,"title":"Account Creation Date","type":"string"},"pricing_plan_type":{"description":"The type of pricing plan the account is on.","enum":["monthly","pay_as_you_go","forever_free"],"readOnly":true,"title":"Account Pricing Plan","type":"string"},"pro_enabled":{"description":"Legacy - whether the account includes [Mailchimp Pro](https://mailchimp.com/help/about-mailchimp-pro/).","readOnly":true,"title":"Mailchimp Pro","type":"boolean"},"role":{"description":"The [user role](https://mailchimp.com/help/manage-user-levels-in-your-account/) for the account.","readOnly":true,"title":"Role","type":"string"},"total_subscribers":{"description":"The total number of subscribers across all lists in the account.","readOnly":true,"title":"Total Subscribers","type":"integer"},"username":{"description":"The username tied to the account.","example":"freddie2000","readOnly":true,"title":"User Name","type":"string"}},"title":"API Root","type":"object"}},"application/problem+json":{"schema":{"description":"The API root resource links to all other resources available in the API.","properties":{"_links":{"description":"A list of link types and descriptions for the API schema documents.","items":{"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","properties":{"href":{"description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.","readOnly":true,"title":"Href","type":"string"},"method":{"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"readOnly":true,"title":"Method","type":"string"},"rel":{"description":"As with an HTML 'rel' attribute, this describes the type of link.","readOnly":true,"title":"Rel","type":"string"},"schema":{"description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.","readOnly":true,"title":"Schema","type":"string"},"targetSchema":{"description":"For GETs, this is a URL representing the schema that the response should conform to.","readOnly":true,"title":"Target Schema","type":"string"}},"title":"Resource Link","type":"object"},"readOnly":true,"title":"Links","type":"array"},"account_id":{"description":"The Mailchimp account ID.","readOnly":true,"title":"Account ID","type":"string"},"account_industry":{"description":"The user-specified industry associated with the account.","readOnly":true,"title":"Account Industry","type":"string"},"account_name":{"description":"The name of the account.","readOnly":true,"title":"Account Name","type":"string"},"account_timezone":{"description":"The timezone currently set for the account.","readOnly":true,"title":"Account Timezone","type":"string"},"avatar_url":{"description":"URL of the avatar for the user.","readOnly":true,"title":"Avatar URL","type":"string"},"contact":{"description":"Information about the account contact.","properties":{"addr1":{"description":"The street address for the account contact.","readOnly":true,"title":"Address Line 1","type":"string"},"addr2":{"description":"The street address for the account contact.","readOnly":true,"title":"Address Line 2","type":"string"},"city":{"description":"The city for the account contact.","readOnly":true,"title":"City","type":"string"},"company":{"description":"The company name for the account.","readOnly":true,"title":"Company","type":"string"},"country":{"description":"The country for the account contact.","readOnly":true,"title":"Country","type":"string"},"state":{"description":"The state for the account contact.","readOnly":true,"title":"State","type":"string"},"zip":{"description":"The zip code for the account contact.","readOnly":true,"title":"Zip Code","type":"string"}},"readOnly":true,"title":"Account Contact","type":"object"},"email":{"description":"The account email address.","readOnly":true,"title":"Account Email","type":"string"},"first_name":{"description":"The first name tied to the account.","readOnly":true,"title":"First Name","type":"string"},"first_payment":{"description":"Date of first payment for monthly plans.","example":"2025-06-15T13:50:44.688Z","format":"date-time","readOnly":true,"title":"First Payment","type":"string"},"industry_stats":{"description":"The [average campaign statistics](https://mailchimp.com/resources/research/email-marketing-benchmarks/?utm_source=mc-api&utm_medium=docs&utm_campaign=apidocs) for all campaigns in the account's specified industry.","properties":{"bounce_rate":{"description":"The average bounce rate for all campaigns in the account's specified industry.","readOnly":true,"title":"Bounce Rate","type":"number"},"click_rate":{"description":"The average unique click rate for all campaigns in the account's specified industry.","readOnly":true,"title":"Click Rate","type":"number"},"open_rate":{"description":"The average unique open rate for all campaigns in the account's specified industry.","readOnly":true,"title":"Open Rate","type":"number"}},"readOnly":true,"title":"Industry Stats","type":"object"},"last_login":{"description":"The date and time of the last login for this account in ISO 8601 format.","format":"date-time","readOnly":true,"title":"Last Login Date","type":"string"},"last_name":{"description":"The last name tied to the account.","readOnly":true,"title":"Last Name","type":"string"},"login_id":{"description":"The ID associated with the user who owns this API key. If you can login to multiple accounts, this ID will be the same for each account.","readOnly":true,"title":"Login ID","type":"string"},"member_since":{"description":"The date and time that the account was created in ISO 8601 format.","example":"2025-06-15T13:50:44.688Z","format":"date-time","readOnly":true,"title":"Account Creation Date","type":"string"},"pricing_plan_type":{"description":"The type of pricing plan the account is on.","enum":["monthly","pay_as_you_go","forever_free"],"readOnly":true,"title":"Account Pricing Plan","type":"string"},"pro_enabled":{"description":"Legacy - whether the account includes [Mailchimp Pro](https://mailchimp.com/help/about-mailchimp-pro/).","readOnly":true,"title":"Mailchimp Pro","type":"boolean"},"role":{"description":"The [user role](https://mailchimp.com/help/manage-user-levels-in-your-account/) for the account.","readOnly":true,"title":"Role","type":"string"},"total_subscribers":{"description":"The total number of subscribers across all lists in the account.","readOnly":true,"title":"Total Subscribers","type":"integer"},"username":{"description":"The username tied to the account.","example":"freddie2000","readOnly":true,"title":"User Name","type":"string"}},"title":"API Root","type":"object"}}},"description":""},"default":{"content":{"application/json":{"schema":{"description":"An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.","properties":{"detail":{"description":"A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors).","example":"The requested resource could not be found.","title":"Error Message","type":"string"},"instance":{"description":"A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.","example":"995c5cb0-3280-4a6e-808b-3b096d0bb219","title":"Instance ID","type":"string"},"status":{"description":"The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.","example":404,"title":"HTTP Status Code","type":"integer"},"title":{"description":"A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization.","example":"Resource Not Found","title":"Error Title","type":"string"},"type":{"description":"An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.","example":"https://mailchimp.com/developer/marketing/docs/errors/","title":"Problem Type","type":"string"}},"required":["type","title","status","detail","instance"],"title":"Problem Detail Document","type":"object"}},"application/problem+json":{"schema":{"description":"An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.","properties":{"detail":{"description":"A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors).","example":"The requested resource could not be found.","title":"Error Message","type":"string"},"instance":{"description":"A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.","example":"995c5cb0-3280-4a6e-808b-3b096d0bb219","title":"Instance ID","type":"string"},"status":{"description":"The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.","example":404,"title":"HTTP Status Code","type":"integer"},"title":{"description":"A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization.","example":"Resource Not Found","title":"Error Title","type":"string"},"type":{"description":"An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.","example":"https://mailchimp.com/developer/marketing/docs/errors/","title":"Problem Type","type":"string"}},"required":["type","title","status","detail","instance"],"title":"Problem Detail Document","type":"object"}}},"description":"An error generated by the Mailchimp API."}},"summary":"List api root resources","tags":["root"],"x-custom-config":{"methodNameCamel":"getRoot","methodNameSnake":"get_root"}}},"/account-exports":{"get":{"deprecated":false,"description":"Get a list of account exports for a given account.","operationId":"getAccountExports","parameters":[{"description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","explode":false,"in":"query","name":"fields","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form","x-title":"Fields"},{"description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","explode":false,"in":"query","name":"exclude_fields","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form","x-title":"Exclude Fields"},{"description":"The number of records to return. Default value is 10. Maximum value is 1000","in":"query","name":"count","required":false,"schema":{"default":10,"maximum":1000,"type":"integer"},"x-title":"Count"},{"description":"Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.","in":"query","name":"offset","required":false,"schema":{"default":0,"type":"integer"},"x-title":"Offset"}],"responses":{"200":{"content":{"application/json":{"schema":{"description":"An array of objects, each representing an account export.","properties":{"_links":{"description":"A list of link types and descriptions for the API schema documents.","items":{"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","properties":{"href":{"description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.","readOnly":true,"title":"Href","type":"string"},"method":{"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"readOnly":true,"title":"Method","type":"string"},"rel":{"description":"As with an HTML 'rel' attribute, this describes the type of link.","readOnly":true,"title":"Rel","type":"string"},"schema":{"description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.","readOnly":true,"title":"Schema","type":"string"},"targetSchema":{"description":"For GETs, this is a URL representing the schema that the response should conform to.","readOnly":true,"title":"Target Schema","type":"string"}},"title":"Resource Link","type":"object"},"readOnly":true,"title":"Links","type":"array"},"exports":{"description":"An array of objects, each representing an account export.","items":{"description":"An account export.","properties":{"_links":{"description":"A list of link types and descriptions for the API schema documents.","items":{"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","properties":{"href":{"description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.","readOnly":true,"title":"Href","type":"string"},"method":{"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"readOnly":true,"title":"Method","type":"string"},"rel":{"description":"As with an HTML 'rel' attribute, this describes the type of link.","readOnly":true,"title":"Rel","type":"string"},"schema":{"description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.","readOnly":true,"title":"Schema","type":"string"},"targetSchema":{"description":"For GETs, this is a URL representing the schema that the response should conform to.","readOnly":true,"title":"Target Schema","type":"string"}},"title":"Resource Link","type":"object"},"readOnly":true,"title":"Links","type":"array"},"download_url":{"description":"If the export is finished, the download URL for an export. URLs are only valid for 90 days after the export completes.","title":"Download URL","type":"string"},"export_id":{"description":"The ID for the export.","title":"Export ID","type":"integer"},"finished":{"description":"If finished, the finish time for the export.","format":"date-time","title":"Finish Time","type":"string"},"size_in_bytes":{"description":"The size of the uncompressed export in bytes.","title":"Export Size","type":"integer"},"started":{"description":"Start time for the export.","format":"date-time","title":"Start Time","type":"string"}},"type":"object"},"title":"Account Exports","type":"array"},"total_items":{"description":"The total number of items matching the query regardless of pagination.","readOnly":true,"title":"Item Count","type":"integer"}},"type":"object"}},"application/problem+json":{"schema":{"description":"An array of objects, each representing an account export.","properties":{"_links":{"description":"A list of link types and descriptions for the API schema documents.","items":{"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","properties":{"href":{"description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.","readOnly":true,"title":"Href","type":"string"},"method":{"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"readOnly":true,"title":"Method","type":"string"},"rel":{"description":"As with an HTML 'rel' attribute, this describes the type of link.","readOnly":true,"title":"Rel","type":"string"},"schema":{"description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.","readOnly":true,"title":"Schema","type":"string"},"targetSchema":{"description":"For GETs, this is a URL representing the schema that the response should conform to.","readOnly":true,"title":"Target Schema","type":"string"}},"title":"Resource Link","type":"object"},"readOnly":true,"title":"Links","type":"array"},"exports":{"description":"An array of objects, each representing an account export.","items":{"description":"An account export.","properties":{"_links":{"description":"A list of link types and descriptions for the API schema documents.","items":{"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","properties":{"href":{"description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.","readOnly":true,"title":"Href","type":"string"},"method":{"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"readOnly":true,"title":"Method","type":"string"},"rel":{"description":"As with an HTML 'rel' attribute, this describes the type of link.","readOnly":true,"title":"Rel","type":"string"},"schema":{"description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.","readOnly":true,"title":"Schema","type":"string"},"targetSchema":{"description":"For GETs, this is a URL representing the schema that the response should conform to.","readOnly":true,"title":"Target Schema","type":"string"}},"title":"Resource Link","type":"object"},"readOnly":true,"title":"Links","type":"array"},"download_url":{"description":"If the export is finished, the download URL for an export. URLs are only valid for 90 days after the export completes.","title":"Download URL","type":"string"},"export_id":{"description":"The ID for the export.","title":"Export ID","type":"integer"},"finished":{"description":"If finished, the finish time for the export.","format":"date-time","title":"Finish Time","type":"string"},"size_in_bytes":{"description":"The size of the uncompressed export in bytes.","title":"Export Size","type":"integer"},"started":{"description":"Start time for the export.","format":"date-time","title":"Start Time","type":"string"}},"type":"object"},"title":"Account Exports","type":"array"},"total_items":{"description":"The total number of items matching the query regardless of pagination.","readOnly":true,"title":"Item Count","type":"integer"}},"type":"object"}}},"description":""},"default":{"content":{"application/json":{"schema":{"description":"An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.","properties":{"detail":{"description":"A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors).","example":"The requested resource could not be found.","title":"Error Message","type":"string"},"instance":{"description":"A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.","example":"995c5cb0-3280-4a6e-808b-3b096d0bb219","title":"Instance ID","type":"string"},"status":{"description":"The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.","example":404,"title":"HTTP Status Code","type":"integer"},"title":{"description":"A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization.","example":"Resource Not Found","title":"Error Title","type":"string"},"type":{"description":"An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.","example":"https://mailchimp.com/developer/marketing/docs/errors/","title":"Problem Type","type":"string"}},"required":["type","title","status","detail","instance"],"title":"Problem Detail Document","type":"object"}},"application/problem+json":{"schema":{"description":"An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.","properties":{"detail":{"description":"A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors).","example":"The requested resource could not be found.","title":"Error Message","type":"string"},"instance":{"description":"A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.","example":"995c5cb0-3280-4a6e-808b-3b096d0bb219","title":"Instance ID","type":"string"},"status":{"description":"The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.","example":404,"title":"HTTP Status Code","type":"integer"},"title":{"description":"A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization.","example":"Resource Not Found","title":"Error Title","type":"string"},"type":{"description":"An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.","example":"https://mailchimp.com/developer/marketing/docs/errors/","title":"Problem Type","type":"string"}},"required":["type","title","status","detail","instance"],"title":"Problem Detail Document","type":"object"}}},"description":"An error generated by the Mailchimp API."}},"summary":"List account exports","tags":["accountExports"],"x-custom-config":{"methodNameCamel":"listAccountExports","methodNameSnake":"list_account_exports"}},"post":{"deprecated":false,"description":"Create a new account export in your Mailchimp account.","operationId":"postAccountExport","requestBody":{"content":{"application/json":{"schema":{"description":"Creates an account export with the given parameters.","properties":{"include_stages":{"description":"The stages of an account export to include.","example":"[\"audiences\", \"gallery_files\"]","items":{"enum":["audiences","campaigns","events","gallery_files","reports","templates"],"type":"string"},"title":"Include Stages","type":"array"},"since_timestamp":{"description":"An ISO 8601 date that will limit the export to only records created after a given time. For instance, the reports stage will contain any campaign sent after the given timestamp. Audiences, however, are excluded from this limit.","example":"2025-06-15T13:50:44.689Z","format":"date-time","title":"Since Timestamp","type":"string"}},"required":["include_stages"],"title":"Create an account export","type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"description":"An account export.","properties":{"_links":{"description":"A list of link types and descriptions for the API schema documents.","items":{"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","properties":{"href":{"description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.","readOnly":true,"title":"Href","type":"string"},"method":{"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"readOnly":true,"title":"Method","type":"string"},"rel":{"description":"As with an HTML 'rel' attribute, this describes the type of link.","readOnly":true,"title":"Rel","type":"string"},"schema":{"description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.","readOnly":true,"title":"Schema","type":"string"},"targetSchema":{"description":"For GETs, this is a URL representing the schema that the response should conform to.","readOnly":true,"title":"Target Schema","type":"string"}},"title":"Resource Link","type":"object"},"readOnly":true,"title":"Links","type":"array"},"download_url":{"description":"If the export is finished, the download URL for an export. URLs are only valid for 90 days after the export completes.","title":"Download URL","type":"string"},"export_id":{"description":"The ID for the export.","title":"Export ID","type":"integer"},"finished":{"description":"If finished, the finish time for the export.","format":"date-time","title":"Finish Time","type":"string"},"size_in_bytes":{"description":"The size of the uncompressed export in bytes.","title":"Export Size","type":"integer"},"started":{"description":"Start time for the export.","format":"date-time","title":"Start Time","type":"string"}},"type":"object"}},"application/problem+json":{"schema":{"description":"An account export.","properties":{"_links":{"description":"A list of link types and descriptions for the API schema documents.","items":{"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","properties":{"href":{"description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.","readOnly":true,"title":"Href","type":"string"},"method":{"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"readOnly":true,"title":"Method","type":"string"},"rel":{"description":"As with an HTML 'rel' attribute, this describes the type of link.","readOnly":true,"title":"Rel","type":"string"},"schema":{"description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.","readOnly":true,"title":"Schema","type":"string"},"targetSchema":{"description":"For GETs, this is a URL representing the schema that the response should conform to.","readOnly":true,"title":"Target Schema","type":"string"}},"title":"Resource Link","type":"object"},"readOnly":true,"title":"Links","type":"array"},"download_url":{"description":"If the export is finished, the download URL for an export. URLs are only valid for 90 days after the export completes.","title":"Download URL","type":"string"},"export_id":{"description":"The ID for the export.","title":"Export ID","type":"integer"},"finished":{"description":"If finished, the finish time for the export.","format":"date-time","title":"Finish Time","type":"string"},"size_in_bytes":{"description":"The size of the uncompressed export in bytes.","title":"Export Size","type":"integer"},"started":{"description":"Start time for the export.","format":"date-time","title":"Start Time","type":"string"}},"type":"object"}}},"description":""},"default":{"content":{"application/json":{"schema":{"description":"An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.","properties":{"detail":{"description":"A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors).","example":"The requested resource could not be found.","title":"Error Message","type":"string"},"instance":{"description":"A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.","example":"995c5cb0-3280-4a6e-808b-3b096d0bb219","title":"Instance ID","type":"string"},"status":{"description":"The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.","example":404,"title":"HTTP Status Code","type":"integer"},"title":{"description":"A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization.","example":"Resource Not Found","title":"Error Title","type":"string"},"type":{"description":"An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.","example":"https://mailchimp.com/developer/marketing/docs/errors/","title":"Problem Type","type":"string"}},"required":["type","title","status","detail","instance"],"title":"Problem Detail Document","type":"object"}},"application/problem+json":{"schema":{"description":"An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.","properties":{"detail":{"description":"A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors).","example":"The requested resource could not be found.","title":"Error Message","type":"string"},"instance":{"description":"A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.","example":"995c5cb0-3280-4a6e-808b-3b096d0bb219","title":"Instance ID","type":"string"},"status":{"description":"The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.","example":404,"title":"HTTP Status Code","type":"integer"},"title":{"description":"A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization.","example":"Resource Not Found","title":"Error Title","type":"string"},"type":{"description":"An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.","example":"https://mailchimp.com/developer/marketing/docs/errors/","title":"Problem Type","type":"string"}},"required":["type","title","status","detail","instance"],"title":"Problem Detail Document","type":"object"}}},"description":"An error generated by the Mailchimp API."}},"summary":"Add export","tags":["accountExports"],"x-custom-config":{"methodNameCamel":"createAccountExport","methodNameSnake":"create_account_export"}}},"/account-exports/{export_id}":{"get":{"deprecated":false,"description":"Get information about a specific account export.","operationId":"getAccountExportId","parameters":[{"description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","explode":false,"in":"query","name":"fields","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form","x-title":"Fields"},{"description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","explode":false,"in":"query","name":"exclude_fields","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form","x-title":"Exclude Fields"},{"description":"The unique id for the account export.","in":"path","name":"export_id","required":true,"schema":{"type":"string"},"x-title":"Export ID"}],"responses":{"200":{"content":{"application/json":{"schema":{"description":"An account export.","properties":{"_links":{"description":"A list of link types and descriptions for the API schema documents.","items":{"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","properties":{"href":{"description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.","readOnly":true,"title":"Href","type":"string"},"method":{"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"readOnly":true,"title":"Method","type":"string"},"rel":{"description":"As with an HTML 'rel' attribute, this describes the type of link.","readOnly":true,"title":"Rel","type":"string"},"schema":{"description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.","readOnly":true,"title":"Schema","type":"string"},"targetSchema":{"description":"For GETs, this is a URL representing the schema that the response should conform to.","readOnly":true,"title":"Target Schema","type":"string"}},"title":"Resource Link","type":"object"},"readOnly":true,"title":"Links","type":"array"},"download_url":{"description":"If the export is finished, the download URL for an export. URLs are only valid for 90 days after the export completes.","title":"Download URL","type":"string"},"export_id":{"description":"The ID for the export.","title":"Export ID","type":"integer"},"finished":{"description":"If finished, the finish time for the export.","format":"date-time","title":"Finish Time","type":"string"},"size_in_bytes":{"description":"The size of the uncompressed export in bytes.","title":"Export Size","type":"integer"},"started":{"description":"Start time for the export.","format":"date-time","title":"Start Time","type":"string"}},"type":"object"}},"application/problem+json":{"schema":{"description":"An account export.","properties":{"_links":{"description":"A list of link types and descriptions for the API schema documents.","items":{"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","properties":{"href":{"description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.","readOnly":true,"title":"Href","type":"string"},"method":{"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"readOnly":true,"title":"Method","type":"string"},"rel":{"description":"As with an HTML 'rel' attribute, this describes the type of link.","readOnly":true,"title":"Rel","type":"string"},"schema":{"description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.","readOnly":true,"title":"Schema","type":"string"},"targetSchema":{"description":"For GETs, this is a URL representing the schema that the response should conform to.","readOnly":true,"title":"Target Schema","type":"string"}},"title":"Resource Link","type":"object"},"readOnly":true,"title":"Links","type":"array"},"download_url":{"description":"If the export is finished, the download URL for an export. URLs are only valid for 90 days after the export completes.","title":"Download URL","type":"string"},"export_id":{"description":"The ID for the export.","title":"Export ID","type":"integer"},"finished":{"description":"If finished, the finish time for the export.","format":"date-time","title":"Finish Time","type":"string"},"size_in_bytes":{"description":"The size of the uncompressed export in bytes.","title":"Export Size","type":"integer"},"started":{"description":"Start time for the export.","format":"date-time","title":"Start Time","type":"string"}},"type":"object"}}},"description":""},"default":{"content":{"application/json":{"schema":{"description":"An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.","properties":{"detail":{"description":"A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors).","example":"The requested resource could not be found.","title":"Error Message","type":"string"},"instance":{"description":"A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.","example":"995c5cb0-3280-4a6e-808b-3b096d0bb219","title":"Instance ID","type":"string"},"status":{"description":"The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.","example":404,"title":"HTTP Status Code","type":"integer"},"title":{"description":"A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization.","example":"Resource Not Found","title":"Error Title","type":"string"},"type":{"description":"An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.","example":"https://mailchimp.com/developer/marketing/docs/errors/","title":"Problem Type","type":"string"}},"required":["type","title","status","detail","instance"],"title":"Problem Detail Document","type":"object"}},"application/problem+json":{"schema":{"description":"An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.","properties":{"detail":{"description":"A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors).","example":"The requested resource could not be found.","title":"Error Message","type":"string"},"instance":{"description":"A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.","example":"995c5cb0-3280-4a6e-808b-3b096d0bb219","title":"Instance ID","type":"string"},"status":{"description":"The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.","example":404,"title":"HTTP Status Code","type":"integer"},"title":{"description":"A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization.","example":"Resource Not Found","title":"Error Title","type":"string"},"type":{"description":"An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.","example":"https://mailchimp.com/developer/marketing/docs/errors/","title":"Problem Type","type":"string"}},"required":["type","title","status","detail","instance"],"title":"Problem Detail Document","type":"object"}}},"description":"An error generated by the Mailchimp API."}},"summary":"Get account export info","tags":["accountExport"],"x-custom-config":{"methodNameCamel":"getAccountExports","methodNameSnake":"get_account_exports"}}},"/activity-feed/chimp-chatter":{"get":{"description":"Return the Chimp Chatter for this account ordered by most recent.","operationId":"getActivityFeedChimpChatter","parameters":[{"description":"The number of records to return. Default value is 10. Maximum value is 1000","in":"query","name":"count","required":false,"schema":{"default":10,"maximum":1000,"type":"integer"},"x-title":"Count"},{"description":"Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.","in":"query","name":"offset","required":false,"schema":{"default":0,"type":"integer"},"x-title":"Offset"}],"responses":{"200":{"content":{"application/json":{"schema":{"description":"An array of Chimp Chatter messages. There's a maximum of 200 messages present for an account.","properties":{"_links":{"description":"A list of link types and descriptions for the API schema documents.","items":{"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","properties":{"href":{"description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.","readOnly":true,"title":"Href","type":"string"},"method":{"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"readOnly":true,"title":"Method","type":"string"},"rel":{"description":"As with an HTML 'rel' attribute, this describes the type of link.","readOnly":true,"title":"Rel","type":"string"},"schema":{"description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.","readOnly":true,"title":"Schema","type":"string"},"targetSchema":{"description":"For GETs, this is a URL representing the schema that the response should conform to.","readOnly":true,"title":"Target Schema","type":"string"}},"title":"Resource Link","type":"object"},"readOnly":true,"title":"Links","type":"array"},"chimp_chatter":{"description":"An array of Chimp Chatter messages. There's a maximum of 200 messages present for an account.","items":{"description":"A Chimp Chatter message","properties":{"campaign_id":{"description":"If it exists, campaign ID for the associated campaign","example":"2025-06-15T13:50:44.689Z","readOnly":true,"title":"Campaign ID","type":"string"},"list_id":{"description":"If it exists, list ID for the associated list","example":"2025-06-15T13:50:44.689Z","readOnly":true,"title":"List ID","type":"string"},"message":{"example":"People are telling their friends about your campaign!","readOnly":true,"title":"Message","type":"string"},"title":{"example":"1 new subscriber to Your New Campaign!","readOnly":true,"title":"Title","type":"string"},"type":{"description":"The type of activity","enum":["lists:new-subscriber","lists:unsubscribes","lists:profile-updates","campaigns:facebook-likes","campaigns:forward-to-friend","lists:imports"],"example":"campaigns:forward-to-friend","readOnly":true,"title":"Type","type":"string"},"update_time":{"description":"The date and time this activity was updated.","example":"2025-06-15T13:50:44.689Z","format":"date-time","readOnly":true,"title":"Update Time","type":"string"},"url":{"description":"URL to a report that includes this activity","example":"http://dev.mailchimp.com/reports/summary?id=1","readOnly":true,"title":"URL","type":"string"}},"title":"ChimpChatter","type":"object"},"readOnly":true,"type":"array"},"total_items":{"description":"The total number of items matching the query regardless of pagination.","readOnly":true,"title":"Item Count","type":"integer"}},"type":"object"}},"application/problem+json":{"schema":{"description":"An array of Chimp Chatter messages. There's a maximum of 200 messages present for an account.","properties":{"_links":{"description":"A list of link types and descriptions for the API schema documents.","items":{"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","properties":{"href":{"description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.","readOnly":true,"title":"Href","type":"string"},"method":{"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"readOnly":true,"title":"Method","type":"string"},"rel":{"description":"As with an HTML 'rel' attribute, this describes the type of link.","readOnly":true,"title":"Rel","type":"string"},"schema":{"description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.","readOnly":true,"title":"Schema","type":"string"},"targetSchema":{"description":"For GETs, this is a URL representing the schema that the response should conform to.","readOnly":tr