swagger: '2.0'
info:
version: 3.0.55
title: Mailchimp Marketing Abuse Verified 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: Verified
paths:
/verified-domains/{domain_name}:
get:
summary: Mailchimp Get Domain Info
description: Get the details for a single domain on the account.
operationId: getVerifiedDomain
parameters:
- in: path
name: domain_name
x-title: Domain Name
type: string
required: true
description: The domain name.
example: example_value
responses:
'200':
description: ''
schema:
type: object
title: Verified Domains
description: The verified domains currently on the account.
properties:
domain:
type: string
title: Domain Name
description: The name of this domain.
readOnly: true
verified:
type: boolean
title: Verified
description: Whether the domain has been verified for sending.
readOnly: true
authenticated:
type: boolean
title: Authenticated
description: Whether domain authentication is enabled for this domain.
readOnly: true
verification_email:
type: string
title: Verification Email
description: The e-mail address receiving the two-factor challenge for this domain.
readOnly: true
verification_sent:
type: string
format: date-time
title: Verification Challenge Sent
description: The date/time that the two-factor challenge was sent to the verification email.
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:
- Verified
x-custom-config:
methodNameSnake: get_domain
methodNameCamel: getDomain
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
delete:
summary: Mailchimp Delete Domain
description: Delete a verified domain from the account.
operationId: deleteVerifiedDomain
parameters:
- in: path
name: domain_name
x-title: Domain Name
type: string
required: true
description: The domain name.
example: example_value
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:
- Verified
x-custom-config:
methodNameSnake: delete_domain
methodNameCamel: deleteDomain
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/verified-domains/{domain_name}/actions/verify:
post:
summary: Mailchimp Verify Domain
description: Verify a domain for sending.
operationId: verifyDomain
parameters:
- in: path
name: domain_name
x-title: Domain Name
type: string
required: true
description: The domain name.
example: example_value
- in: body
name: body
description: ''
required: true
schema:
type: object
title: Verify a domain for sending.
description: Submit a response to the verification challenge and verify a domain for sending.
required:
- code
properties:
code:
type: string
title: Verification Code
description: The code that was sent to the email address provided when adding a new domain to verify.
example: example_value
responses:
'200':
description: The domain being verified for sending.
schema:
type: object
title: Verified Domains
description: The verified domains currently on the account.
properties:
domain:
type: string
title: Domain Name
description: The name of this domain.
readOnly: true
verified:
type: boolean
title: Verified
description: Whether the domain has been verified for sending.
readOnly: true
authenticated:
type: boolean
title: Authenticated
description: Whether domain authentication is enabled for this domain.
readOnly: true
verification_email:
type: string
title: Verification Email
description: The e-mail address receiving the two-factor challenge for this domain.
readOnly: true
verification_sent:
type: string
format: date-time
title: Verification Challenge Sent
description: The date/time that the two-factor challenge was sent to the verification email.
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:
- Verified
x-custom-config:
methodNameSnake: submit_domain_verification
methodNameCamel: submitDomainVerification
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/verified-domains:
get:
summary: Mailchimp List Sending Domains
description: Get all of the sending domains on the account.
operationId: getVerifiedDomains
responses:
'200':
description: The domains on the account.
schema:
type: object
title: Verified Domains
description: The verified domains currently on the account.
properties:
domains:
type: array
title: Domains
description: The domains on the account
readOnly: true
items:
type: object
title: Verified Domains
description: The verified domains currently on the account.
properties:
domain:
type: string
title: Domain Name
description: The name of this domain.
readOnly: true
verified:
type: boolean
title: Verified
description: Whether the domain has been verified for sending.
readOnly: true
authenticated:
type: boolean
title: Authenticated
description: Whether domain authentication is enabled for this domain.
readOnly: true
verification_email:
type: string
title: Verification Email
description: The e-mail address receiving the two-factor challenge for this domain.
readOnly: true
verification_sent:
type: string
format: date-time
title: Verification Challenge Sent
description: The date/time that the two-factor challenge was sent to the verification email.
readOnly: true
total_items:
type: integer
title: Item Count
description: The total number of items matching the query regardless of pagination.
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:
- Verified
x-custom-config:
methodNameSnake: get_verified_domains_all
methodNameCamel: getVerifiedDomainsAll
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
post:
summary: Mailchimp Add Domain to Account
description: Add a domain to the account.
operationId: createVerifiedDomain
parameters:
- in: body
name: body
description: ''
required: true
schema:
type: object
title: Verified Domains
description: The verified domains currently on the account.
required:
- verification_email
properties:
verification_email:
type: string
title: Verification Email
description: The e-mail address at the domain you want to verify. This will receive a two-factor challenge to be used in the verify action.
example: example_value
responses:
'200':
description: The newly-created domain.
schema:
type: object
title: Verified Domains
description: The verified domains currently on the account.
properties:
domain:
type: string
title: Domain Name
description: The name of this domain.
readOnly: true
verified:
type: boolean
title: Verified
description: Whether the domain has been verified for sending.
readOnly: true
authenticated:
type: boolean
title: Authenticated
description: Whether domain authentication is enabled for this domain.
readOnly: true
verification_email:
type: string
title: Verification Email
description: The e-mail address receiving the two-factor challenge for this domain.
readOnly: true
verification_sent:
type: string
format: date-time
title: Verification Challenge Sent
description: The date/time that the two-factor challenge was sent to the verification email.
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:
- Verified
x-custom-config:
methodNameSnake: create_verified_domain
methodNameCamel: createVerifiedDomain
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/{list_id}/abuse-reports/{report_id}
list-activity:
title: Activity
description: Get recent daily, aggregated activity stats for your list. For example, view unsubscribes, signups, total emails sent, opens, clicks, and more, for up to 180 days.
paths:
- /lists/{list_id}/activity
list-clients:
title: Clients
description: Get information about the most popular email clients for subscribers in a specific Mailchimp list.
paths:
- /lists/{list_id}/clients
list-growth-history:
title: Growth History
description: View a summary of the month-by-month growth activity for a specific list.
paths:
- /lists/{list_id}/growth-history
- /lists/{list_id}/growth-history/{month}
list-webhooks:
title: Webhooks
description: Manage webhooks for a specific Mailchimp list.
paths:
- /lists/{list_id}/webhooks
- /lists/{list_id}/webhooks/{webhook_id}
list-surveys:
title: Surveys
description: Get survey data for this audience.
paths:
- /lists/{list_id}/surveys
- /lists/{list_id}/surveys/{survey_id}
- /lists/{list_id}/surveys/{survey_id}/actions/publish
- /lists/{list_id}/surveys/{survey_id}/actions/unpublish
- /lists/{list_id}/surveys/{survey_id}/actions/create-email
interest-categories:
title: Interest Categories
description: Manage interest categories for a specific list. Interest categories organize interests, which are used to group subscribers based on their preferences. These correspond to 'group titles' in the Mailchimp application.
paths:
- /lists/{list_id}/interest-categories
- /lists/{list_id}/interest-categories/{interest_category_id}
subResources:
- interests
interests:
title: Interests
description: Manage interests for a specific Mailchimp list. Assign subscribers to interests to group them together. Interests are referred to as 'group names' in the Mailchimp application.
paths:
- /lists/{list_id}/interest-categories/{interest_category_id}/interests
- /lists/{list_id}/interest-categories/{interest_category_id}/interests/{interest_id}
lists-tags-search:
title: Tag Search
description: Search for tags on a list by name.
paths:
- /lists/{list_id}/tag-search
list-segments:
title: Segments
description: Manage segments and tags for a specific Mailchimp list. A segment is a section of your list that includes only those subscribers who share specific common field information. Tags are labels you create to help organize your contacts.
paths:
- /lists/{list_id}/segments
- /lists/{list_id}/segments/{segment_id}
subResources:
- list-segment-members
list-segment-members:
title: Segment Members
description: Manage list members in a saved segment.
paths:
- /lists/{list_id}/segments/{segment_
# --- truncated at 32 KB (46 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mailchimp/refs/heads/main/openapi/mailchimp-verified-api-openapi.yml