swagger: '2.0'
info:
version: 3.0.55
title: Mailchimp Marketing Abuse Open 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: Open
paths:
/reports/{campaign_id}/open-details:
get:
summary: Mailchimp List Campaign Open Details
description: Get detailed information about any campaign emails that were opened by a list member.
operationId: getReportsIdOpenDetails
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
- in: path
name: campaign_id
x-title: Campaign ID
type: string
required: true
description: The unique id for the campaign.
example: '500123'
- name: since
x-title: Campaign opens since
in: query
required: false
description: 'Restrict results to campaign open events that occur after a specific time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.'
type: string
x-example: '2016-04-12 12:00:00'
example: example_value
- name: sort_field
x-title: Sort By Field
description: Returns open reports sorted by the specified field.
in: query
required: false
type: string
enum:
- opens_count
example: example_value
- name: sort_dir
x-title: Sort Direction
description: Determines the order direction for sorted results.
in: query
required: false
type: string
enum:
- ASC
- DESC
example: example_value
responses:
'200':
description: ''
schema:
type: object
title: Open Detail Report
description: A detailed report of any campaign emails that were opened by a list member.
properties:
members:
type: array
items:
type: object
title: Open Activity
description: A list of a member's opens activity in a specific campaign.
properties:
campaign_id:
type: string
title: Campaign ID
description: The unique id for the campaign.
readOnly: true
list_id:
type: string
title: List ID
description: The unique id for the list.
readOnly: true
list_is_active:
type: boolean
title: List Status
description: The status of the list used, namely if it's deleted or disabled.
readOnly: true
contact_status:
type: string
title: Member Status
description: The status of the member, namely if they are subscribed, unsubscribed, deleted, non-subscribed, transactional, pending, or need reconfirmation.
readOnly: true
email_id:
type: string
title: Email Hash
description: The MD5 hash of the lowercase version of the list member's email address.
readOnly: true
email_address:
type: string
title: Email Address
description: Email address for a subscriber.
readOnly: true
merge_fields:
type: object
title: Merge Fields
description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.
additionalProperties:
description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field.
vip:
type: boolean
title: VIP
description: '[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber.'
readOnly: true
opens_count:
type: integer
title: Opens count
description: The total number of times the this campaign was opened by the list member.
readOnly: true
opens:
type: array
title: Time series data of opens activity
description: An array of timestamps for each time a list member opened the campaign. If a list member opens an email multiple times, this will return a separate timestamp for each open event.
items:
type: object
title: Member Activity
description: A summary of the interaction with the campaign.
properties:
timestamp:
type: string
title: Timestamp
description: The date and time recorded for the action in ISO 8601 format.
format: date-time
_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: Open Reports
description: An array of objects, each representing a list member who opened a campaign email. Each members object will contain information about the number of total opens by a single member, as well as timestamps for each open event.
campaign_id:
type: string
title: Campaign ID
description: The campaign id.
readOnly: true
total_opens:
type: integer
title: Total opens
description: The total number of opens matching the query regardless of pagination.
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:
- Open
x-custom-config:
methodNameSnake: get_campaign_open_details
methodNameCamel: getCampaignOpenDetails
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/reports/{campaign_id}/open-details/{subscriber_hash}:
get:
summary: Mailchimp Get Opened Campaign Subscriber
description: Get information about a specific subscriber who opened a campaign.
operationId: getReportsIdOpenDetailsIdMembersId
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: campaign_id
x-title: Campaign ID
type: string
required: true
description: The unique id for the campaign.
example: '500123'
- in: path
name: subscriber_hash
x-title: Subscriber Hash
type: string
required: true
description: The MD5 hash of the lowercase version of the list member's email address.
example: example_value
responses:
'200':
description: ''
schema:
type: object
title: Open Activity
description: A list of a member's opens activity in a specific campaign.
properties:
campaign_id:
type: string
title: Campaign ID
description: The unique id for the campaign.
readOnly: true
list_id:
type: string
title: List ID
description: The unique id for the list.
readOnly: true
list_is_active:
type: boolean
title: List Status
description: The status of the list used, namely if it's deleted or disabled.
readOnly: true
contact_status:
type: string
title: Member Status
description: The status of the member, namely if they are subscribed, unsubscribed, deleted, non-subscribed, transactional, pending, or need reconfirmation.
readOnly: true
email_id:
type: string
title: Email Hash
description: The MD5 hash of the lowercase version of the list member's email address.
readOnly: true
email_address:
type: string
title: Email Address
description: Email address for a subscriber.
readOnly: true
merge_fields:
type: object
title: Merge Fields
description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.
additionalProperties:
description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field.
vip:
type: boolean
title: VIP
description: '[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber.'
readOnly: true
opens_count:
type: integer
title: Opens count
description: The total number of times the this campaign was opened by the list member.
readOnly: true
opens:
type: array
title: Time series data of opens activity
description: An array of timestamps for each time a list member opened the campaign. If a list member opens an email multiple times, this will return a separate timestamp for each open event.
items:
type: object
title: Member Activity
description: A summary of the interaction with the campaign.
properties:
timestamp:
type: string
title: Timestamp
description: The date and time recorded for the action in ISO 8601 format.
format: date-time
_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:
- Open
x-custom-config:
methodNameSnake: get_subscriber_info_for_opened_campaign
methodNameCamel: getSubscriberInfoForOpenedCampaign
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
securityDefinitions:
basicAuth:
type: basic
externalDocs:
description: Learn more with the full Mailchimp API documentation.
url: https://mailchimp.com/developer/marketing/
x-doc-structure:
resources:
root:
title: API Root
description: The API root resource links to all other resources available in the API. Calling the root directory also returns details about the Mailchimp user account.
paths:
- /
subResources: []
chimp-chatter:
title: Chimp Chatter Activity
description: Get the latest Chimp Chatter activity from your account.
paths:
- /activity-feed/chimp-chatter
authorized-apps:
title: Authorized Apps
description: Manage registered, connected apps for your Mailchimp account with the Authorized Apps endpoints.
paths:
- /authorized-apps
- /authorized-apps/{app_id}
automation:
title: Automations
description: Mailchimp's classic automations feature lets you build a series of emails that send to subscribers when triggered by a specific date, activity, or event. Use the API to manage Automation workflows, emails, and queues. Does not include Customer Journeys.
paths:
- /automations
- /automations/{workflow_id}
- /automations/{workflow_id}/actions/start-all-emails
- /automations/{workflow_id}/actions/pause-all-emails
- /automations/{workflow_id}/actions/archive
subResources:
- automation-email
- automation-removed-subscribers
automation-email:
title: Emails
description: Manage individual emails in a classic automation workflow.
paths:
- /automations/{workflow_id}/emails
- /automations/{workflow_id}/emails/{workflow_email_id}
- /automations/{workflow_id}/emails/{workflow_email_id}/actions/pause
- /automations/{workflow_id}/emails/{workflow_email_id}/actions/start
subResources:
- automation-email-queue
automation-email-queue:
title: Queue
description: Manage list member queues for classic automation emails.
paths:
- /automations/{workflow_id}/emails/{workflow_email_id}/queue
- /automations/{workflow_id}/emails/{workflow_email_id}/queue/{subscriber_hash}
subResources: []
automation-removed-subscribers:
title: Removed Subscribers
description: Remove subscribers from a classic automation workflow.
paths:
- /automations/{workflow_id}/removed-subscribers
- /automations/{workflow_id}/removed-subscribers/{subscriber_hash}
subResources: []
batch-operations:
title: Batch Operations
description: Use batch operations to complete multiple operations with a single call.
paths:
- /batches
- /batches/{batch_id}
batch-webhooks:
title: Batch Webhooks
description: 'Manage webhooks for batch operations. '
paths:
- /batch-webhooks
- /batch-webhooks/{batch_webhook_id}
account-exports:
title: Account Exports
description: Generate a new export or download a finished export.
paths:
- /account-exports
- /account-exports/{export_id}
campaigns:
title: Campaigns
description: Campaigns are how you send emails to your Mailchimp list. Use the Campaigns API calls to manage campaigns in your Mailchimp account.
paths:
- /campaigns
- /campaigns/{campaign_id}
- /campaigns/{campaign_id}/actions/cancel-send
- /campaigns/{campaign_id}/actions/send
- /campaigns/{campaign_id}/actions/schedule
- /campaigns/{campaign_id}/actions/unschedule
- /campaigns/{campaign_id}/actions/pause
- /campaigns/{campaign_id}/actions/resume
- /campaigns/{campaign_id}/actions/replicate
- /campaigns/{campaign_id}/actions/test
- /campaigns/{campaign_id}/actions/create-resend
subResources:
- campaign-feedback
- campaign-checklist
- campaign-content
campaign-feedback:
title: Feedback
description: Post comments, reply to team feedback, and send test emails while you're working together on a Mailchimp campaign.
paths:
- /campaigns/{campaign_id}/feedback
- /campaigns/{campaign_id}/feedback/{feedback_id}
campaign-checklist:
title: Send Checklist
description: Review the send checklist for your campaign, and resolve any issues before sending.
paths:
- /campaigns/{campaign_id}/send-checklist
campaign-content:
title: Content
description: Manage the HTML, plain-text, and template content for your Mailchimp campaigns.
paths:
- /campaigns/{campaign_id}/content
connected-sites:
title: Connected Sites
description: Manage sites you've connected to your Mailchimp account.
paths:
- /connected-sites
- /connected-sites/{connected_site_id}
- /connected-sites/{connected_site_id}/actions/verify-script-installation
conversations:
title: Conversations
description: Conversation tracking lets you view subscribers' replies to your campaigns in your Mailchimp account.
paths:
- /conversations
- /conversations/{conversation_id}
subResources:
- conversation-messages
conversation-messages:
title: Messages
description: Manage messages in a specific campaign conversation.
paths:
- /conversations/{conversation_id}/messages
- /conversations/{conversation_id}/messages/{message_id}
customer-journeys-journeys-steps-actions:
title: Customer Journeys
description: Manage Customer Journey automated workflows
paths:
- /customer-journeys/journeys/{journey_id}/steps/{step_id}/actions/trigger
subResources: []
file-manager:
title: File Manager
description: Manage files for your Mailchimp account. The File Manager is a place to store images, documents, and other files you include or link to in your campaigns, templates, or signup forms.
paths: []
subResources:
- file-manager-folders
- file-manager-files
file-manager-folders:
title: File Manager Folders
description: Manage specific folders in the File Manager for your Mailchimp account.
paths:
- /file-manager/folders
- /file-manager/folders/{folder_id}
subResources:
- file-manager-folders-files
file-manager-files:
title: File Manager Files
description: Manage specific files in the File Manager for your Mailchimp account.
paths:
- /file-manager/files
- /file-manager/files/{file_id}
file-manager-folders-files:
title: Files in Folder
description: Manage specific files in a folder.
paths:
- /file-manager/folders/{folder_id}/files
landing-pages:
title: Landing Pages
description: Manage your Landing Pages, including publishing and unpublishing.
paths:
- /landing-pages
- /landing-pages/{page_id}
- /landing-pages/{page_id}/actions/publish
- /landing-pages/{page_id}/actions/unpublish
subResources:
- landing-pages_content
landing-pages_content:
title: Content
description: The HTML content for your Mailchimp landing pages.
paths:
- /landing-pages/{page_id}/content
lists:
title: Lists/Audiences
description: Your Mailchimp list, also known as your audience, is where you store and manage all of your contacts.
paths:
- /lists
- /lists/{list_id}
subResources:
- interest-categories
- list-segments
- abuse-reports
- list-activity
- list-clients
- list-growth-history
- list-imports
- list-members
- list-merges
- list-webhooks
- list-signup-forms
- list-locations
- lists-tags-search
- prebuilt-segments
- list-preview-segment
- list-surveys
- list-sms-program
list-members:
title: Members
description: Manage members of a specific Mailchimp list, including currently subscribed, unsubscribed, and bounced members.
paths:
- /lists/{list_id}/members
- /lists/{list_id}/members/{subscriber_hash}
- /lists/{list_id}/members/{subscriber_hash}/actions/delete-permanent
subResources:
- list-member-activity
- list-member-activity-feed
- list-member-goal
- list-member-notes
- list-member-tags
- list-member-events
list-merges:
title: Merge Fields
description: Manage merge fields for an audience. See [Merge Field documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/) for more.
paths:
- /lists/{list_id}/merge-fields
- /lists/{list_id}/merge-fields/{merge_id}
subResources: []
abuse-reports:
title: Abuse Reports
description: Manage abuse complaints for a specific list. An abuse complaint occurs when your recipient reports an email as spam in their mail program.
paths:
- /lists/{list_id}/abuse-reports
- /lists
# --- truncated at 32 KB (49 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mailchimp/refs/heads/main/openapi/mailchimp-open-api-openapi.yml