swagger: '2.0'
info:
version: 3.0.55
title: Mailchimp Marketing Abuse Connected API
contact:
name: Mailchimp API Support
email: apihelp@mailchimp.com
x-permalink: https://github.com/mailchimp/mailchimp-client-lib-codegen/blob/main/spec/marketing.json
description: '
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.'
host: server.api.mailchimp.com
basePath: /3.0
schemes:
- https
consumes:
- application/json
produces:
- application/json
- application/problem+json
security:
- basicAuth: []
tags:
- name: Connected
paths:
/connected-sites:
get:
summary: Mailchimp List Connected Sites
description: Get all connected sites in an account.
operationId: getConnectedSites
parameters:
- name: fields
x-title: Fields
in: query
description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
required: false
type: array
collectionFormat: csv
items:
type: string
example: example_value
- name: exclude_fields
x-title: Exclude Fields
in: query
description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
required: false
type: array
collectionFormat: csv
items:
type: string
example: example_value
- name: count
x-title: Count
in: query
description: The number of records to return. Default value is 10. Maximum value is 1000
required: false
default: 10
maximum: 1000
type: integer
example: example_value
- name: offset
x-title: Offset
in: query
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.
required: false
default: 0
type: integer
example: example_value
responses:
'200':
description: ''
schema:
type: object
title: Connected Sites
description: A collection of connected sites in the account.
properties:
sites:
type: array
items:
type: object
title: Connected Site
description: Information about a specific connected site.
properties:
foreign_id:
type: string
title: Connected Site Foreign ID
description: The unique identifier for the site.
readOnly: true
example: a180c384d7db88b if created in-app, MC001 if created via API
store_id:
type: string
title: Store ID
description: The unique identifier for the ecommerce store that's associated with the connected site (if any). The store_id for a specific connected site can't change.
readOnly: true
example: MC001
platform:
type: string
title: Connected Site Platform
description: The platform of the connected site.
readOnly: true
example: shopify, magento, bigcommerce, woocommerce
domain:
type: string
title: Domain
description: The connected site domain.
readOnly: true
example: example.myshopify.com
site_script:
type: object
title: Script
description: The script used to connect your site with Mailchimp.
readOnly: true
properties:
url:
type: string
title: Script URL
description: The URL used for any integrations that offer built-in support for connected sites.
example: https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js
fragment:
type: string
title: Script Fragment
description: A pre-built script that you can copy-and-paste into your site to integrate it with Mailchimp.
example: <script id="mcjs">!function(c,h,i,m,p){m=c.createElement(h),p=c.getElementsByTagName(h)[0],m.async=1,m.src=i,p.parentNode.insertBefore(m,p)}(document,"script","https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js");</script>
created_at:
type: string
title: Creation Time
format: date-time
description: The date and time the connected site was created in ISO 8601 format.
readOnly: true
example: '2015-07-15T19:28:00+00:00'
updated_at:
type: string
title: Update Time
format: date-time
description: The date and time the connected site was last updated in ISO 8601 format.
readOnly: true
example: '2015-07-15T19:35:00+00:00'
_links:
title: Links
description: A list of link types and descriptions for the API schema documents.
type: array
items:
type: object
title: Resource Link
description: This object represents a link from the resource where it is found to another resource or action that may be performed.
properties:
rel:
type: string
title: Rel
description: As with an HTML 'rel' attribute, this describes the type of link.
readOnly: true
href:
type: string
title: 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
method:
type: string
title: 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
targetSchema:
type: string
title: Target Schema
description: For GETs, this is a URL representing the schema that the response should conform to.
readOnly: true
schema:
type: string
title: 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
readOnly: true
title: Connected Sites
description: An array of objects, each representing a connected site.
total_items:
type: integer
title: Item Count
description: The total number of items matching the query regardless of pagination.
readOnly: true
_links:
title: Links
description: A list of link types and descriptions for the API schema documents.
type: array
items:
type: object
title: Resource Link
description: This object represents a link from the resource where it is found to another resource or action that may be performed.
properties:
rel:
type: string
title: Rel
description: As with an HTML 'rel' attribute, this describes the type of link.
readOnly: true
href:
type: string
title: 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
method:
type: string
title: 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
targetSchema:
type: string
title: Target Schema
description: For GETs, this is a URL representing the schema that the response should conform to.
readOnly: true
schema:
type: string
title: 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
readOnly: true
default:
description: An error generated by the Mailchimp API.
schema:
type: object
title: Problem Detail Document
description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.
required:
- type
- title
- status
- detail
- instance
properties:
type:
type: string
title: Problem 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:
type: string
title: Error 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
status:
type: integer
title: HTTP Status Code
description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
example: 404
detail:
type: string
title: Error Message
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.
instance:
type: string
title: Instance ID
description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.
example: 995c5cb0-3280-4a6e-808b-3b096d0bb219
deprecated: false
tags:
- Connected
x-custom-config:
methodNameSnake: list
methodNameCamel: list
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
post:
summary: Mailchimp Add Connected Site
description: Create a new Mailchimp connected site.
operationId: postConnectedSites
parameters:
- name: body
in: body
description: ''
required: true
schema:
type: object
title: Connected Site
description: Information about a specific connected site.
required:
- foreign_id
- domain
properties:
foreign_id:
type: string
title: Connected Site Foreign ID
description: The unique identifier for the site.
example: MC001
domain:
type: string
title: Domain
description: The connected site domain.
example: example.com
example: example_value
responses:
'200':
description: ''
schema:
type: object
title: Connected Site
description: Information about a specific connected site.
properties:
foreign_id:
type: string
title: Connected Site Foreign ID
description: The unique identifier for the site.
readOnly: true
example: a180c384d7db88b if created in-app, MC001 if created via API
store_id:
type: string
title: Store ID
description: The unique identifier for the ecommerce store that's associated with the connected site (if any). The store_id for a specific connected site can't change.
readOnly: true
example: MC001
platform:
type: string
title: Connected Site Platform
description: The platform of the connected site.
readOnly: true
example: shopify, magento, bigcommerce, woocommerce
domain:
type: string
title: Domain
description: The connected site domain.
readOnly: true
example: example.myshopify.com
site_script:
type: object
title: Script
description: The script used to connect your site with Mailchimp.
readOnly: true
properties:
url:
type: string
title: Script URL
description: The URL used for any integrations that offer built-in support for connected sites.
example: https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js
fragment:
type: string
title: Script Fragment
description: A pre-built script that you can copy-and-paste into your site to integrate it with Mailchimp.
example: <script id="mcjs">!function(c,h,i,m,p){m=c.createElement(h),p=c.getElementsByTagName(h)[0],m.async=1,m.src=i,p.parentNode.insertBefore(m,p)}(document,"script","https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js");</script>
created_at:
type: string
title: Creation Time
format: date-time
description: The date and time the connected site was created in ISO 8601 format.
readOnly: true
example: '2015-07-15T19:28:00+00:00'
updated_at:
type: string
title: Update Time
format: date-time
description: The date and time the connected site was last updated in ISO 8601 format.
readOnly: true
example: '2015-07-15T19:35:00+00:00'
_links:
title: Links
description: A list of link types and descriptions for the API schema documents.
type: array
items:
type: object
title: Resource Link
description: This object represents a link from the resource where it is found to another resource or action that may be performed.
properties:
rel:
type: string
title: Rel
description: As with an HTML 'rel' attribute, this describes the type of link.
readOnly: true
href:
type: string
title: 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
method:
type: string
title: 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
targetSchema:
type: string
title: Target Schema
description: For GETs, this is a URL representing the schema that the response should conform to.
readOnly: true
schema:
type: string
title: 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
readOnly: true
default:
description: An error generated by the Mailchimp API.
schema:
type: object
title: Problem Detail Document
description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.
required:
- type
- title
- status
- detail
- instance
properties:
type:
type: string
title: Problem 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:
type: string
title: Error 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
status:
type: integer
title: HTTP Status Code
description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
example: 404
detail:
type: string
title: Error Message
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.
instance:
type: string
title: Instance ID
description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.
example: 995c5cb0-3280-4a6e-808b-3b096d0bb219
deprecated: false
tags:
- Connected
x-custom-config:
methodNameSnake: create
methodNameCamel: create
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/connected-sites/{connected_site_id}:
get:
summary: Mailchimp Get Connected Site
description: Get information about a specific connected site.
operationId: getConnectedSitesId
parameters:
- name: fields
x-title: Fields
in: query
description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
required: false
type: array
collectionFormat: csv
items:
type: string
example: example_value
- name: exclude_fields
x-title: Exclude Fields
in: query
description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
required: false
type: array
collectionFormat: csv
items:
type: string
example: example_value
- in: path
name: connected_site_id
x-title: Connected Site Foreign ID
type: string
required: true
description: The unique identifier for the site.
example: '500123'
responses:
'200':
description: ''
schema:
type: object
title: Connected Site
description: Information about a specific connected site.
properties:
foreign_id:
type: string
title: Connected Site Foreign ID
description: The unique identifier for the site.
readOnly: true
example: a180c384d7db88b if created in-app, MC001 if created via API
store_id:
type: string
title: Store ID
description: The unique identifier for the ecommerce store that's associated with the connected site (if any). The store_id for a specific connected site can't change.
readOnly: true
example: MC001
platform:
type: string
title: Connected Site Platform
description: The platform of the connected site.
readOnly: true
example: shopify, magento, bigcommerce, woocommerce
domain:
type: string
title: Domain
description: The connected site domain.
readOnly: true
example: example.myshopify.com
site_script:
type: object
title: Script
description: The script used to connect your site with Mailchimp.
readOnly: true
properties:
url:
type: string
title: Script URL
description: The URL used for any integrations that offer built-in support for connected sites.
example: https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js
fragment:
type: string
title: Script Fragment
description: A pre-built script that you can copy-and-paste into your site to integrate it with Mailchimp.
example: <script id="mcjs">!function(c,h,i,m,p){m=c.createElement(h),p=c.getElementsByTagName(h)[0],m.async=1,m.src=i,p.parentNode.insertBefore(m,p)}(document,"script","https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js");</script>
created_at:
type: string
title: Creation Time
format: date-time
description: The date and time the connected site was created in ISO 8601 format.
readOnly: true
example: '2015-07-15T19:28:00+00:00'
updated_at:
type: string
title: Update Time
format: date-time
description: The date and time the connected site was last updated in ISO 8601 format.
readOnly: true
example: '2015-07-15T19:35:00+00:00'
_links:
title: Links
description: A list of link types and descriptions for the API schema documents.
type: array
items:
type: object
title: Resource Link
description: This object represents a link from the resource where it is found to another resource or action that may be performed.
properties:
rel:
type: string
title: Rel
description: As with an HTML 'rel' attribute, this describes the type of link.
readOnly: true
href:
type: string
title: 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
method:
type: string
title: 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
targetSchema:
type: string
title: Target Schema
description: For GETs, this is a URL representing the schema that the response should conform to.
readOnly: true
schema:
type: string
title: 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
readOnly: true
default:
description: An error generated by the Mailchimp API.
schema:
type: object
title: Problem Detail Document
description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.
required:
- type
- title
- status
- detail
- instance
properties:
type:
type: string
title: Problem 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:
type: string
title: Error 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
status:
type: integer
title: HTTP Status Code
description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
example: 404
detail:
type: string
title: Error Message
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.
instance:
type: string
title: Instance ID
description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.
example: 995c5cb0-3280-4a6e-808b-3b096d0bb219
deprecated: false
tags:
- Connected
x-custom-config:
methodNameSnake: get
methodNameCamel: get
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
delete:
summary: Mailchimp Delete Connected Site
description: Remove a connected site from your Mailchimp account.
operationId: deleteConnectedSitesId
parameters:
- in: path
name: connected_site_id
x-title: Connected Site Foreign ID
type: string
required: true
description: The unique identifier for the site.
example: '500123'
responses:
'204':
description: Empty Response
default:
description: An error generated by the Mailchimp API.
schema:
type: object
title: Problem Detail Document
description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.
required:
- type
- title
- status
- detail
- instance
properties:
type:
type: string
title: Problem 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:
type: string
title: Error 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
status:
type: integer
title: HTTP Status Code
description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
example: 404
detail:
type: string
title: Error Message
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.
instance:
type: string
title: Instance ID
description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.
example: 995c5cb0-3280-4a6e-808b-3b096d0bb219
deprecated: false
tags:
- Connected
x-custom-config:
methodNameSnake: remove
methodNameCamel: remove
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/connected-sites/{connected_site_id}/actions/verify-script-installation:
post:
summary: Mailchimp Verify Connected Site Script
description: Verify that the connected sites script has been installed, either via the script URL or fragment.
operationId: postConnectedSitesIdActionsVerifyScriptInstallation
x-pro-required: true
parameters:
- in: path
name: connected_site_id
x-title: Connected Site Foreign ID
type: string
required: true
description: The unique identifier for the site.
example: '500123'
responses:
'204':
description: Empty Response
default:
description: An error generated by the Mailchimp API.
schema:
type: object
title: Problem Detail Document
description: An error generated by the Mailchimp API. Conforms to IETF d
# --- truncated at 32 KB (59 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mailchimp/refs/heads/main/openapi/mailchimp-connected-api-openapi.yml