Mailchimp Emails API

swagger: '2.0'
info:
  version: 3.0.55
  title: Mailchimp Marketing Abuse Emails 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: Emails
paths:
  /automations/{workflow_id}/actions/pause-all-emails:
    post:
      summary: Mailchimp Pause Automation Emails
      description: Pause all emails in a specific classic automation workflow.
      operationId: postAutomationsIdActionsPauseAllEmails
      parameters:
      - in: path
        name: workflow_id
        type: string
        required: true
        description: The unique id for the Automation workflow.
        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:
      - Emails
      x-custom-config:
        methodNameSnake: pause_all_emails
        methodNameCamel: pauseAllEmails
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /automations/{workflow_id}/actions/start-all-emails:
    post:
      summary: Mailchimp Start Automation Emails
      description: Start all emails in a classic automation workflow.
      operationId: postAutomationsIdActionsStartAllEmails
      parameters:
      - in: path
        name: workflow_id
        type: string
        required: true
        description: The unique id for the Automation workflow.
        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:
      - Emails
      x-custom-config:
        methodNameSnake: start_all_emails
        methodNameCamel: startAllEmails
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /automations/{workflow_id}/emails:
    get:
      summary: Mailchimp List Automated Emails
      description: Get a summary of the emails in a classic automation workflow.
      operationId: getAutomationsIdEmails
      parameters:
      - in: path
        name: workflow_id
        type: string
        required: true
        description: The unique id for the Automation workflow.
        example: '500123'
      responses:
        '200':
          description: ''
          schema:
            type: object
            title: Automation Emails
            description: A summary of the emails in an Automation workflow.
            properties:
              emails:
                type: array
                items:
                  type: object
                  title: Automation Workflow Email
                  description: A summary of an individual Automation workflow email.
                  properties:
                    id:
                      type: string
                      title: Automation Email ID
                      description: A string that uniquely identifies the Automation email.
                      readOnly: true
                    web_id:
                      type: integer
                      title: Automation Web ID
                      description: The ID used in the Mailchimp web application. View this automation in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`.
                      readOnly: true
                      example: 33345484
                    workflow_id:
                      type: string
                      title: Workflow ID
                      description: A string that uniquely identifies an Automation workflow.
                      readOnly: true
                    position:
                      type: integer
                      title: Email Position
                      description: The position of an Automation email in a workflow.
                      readOnly: true
                    delay:
                      type: object
                      title: Automation Delay
                      description: The delay settings for an Automation email.
                      properties:
                        amount:
                          type: integer
                          title: Delay Amount
                          description: The delay amount for an Automation email.
                          readOnly: true
                        type:
                          type: string
                          enum:
                          - now
                          - day
                          - hour
                          - week
                          title: Delay Type
                          description: The type of delay for an Automation email.
                        direction:
                          type: string
                          title: Delay Direction
                          description: Whether the delay settings describe before or after the delay action of an Automation email.
                          enum:
                          - before
                          - after
                        action:
                          type: string
                          title: Delay Action
                          description: The action that triggers the delay of an Automation email.
                          enum:
                          - previous_campaign_sent
                          - previous_campaign_opened
                          - previous_campaign_not_opened
                          - previous_campaign_clicked_any
                          - previous_campaign_not_clicked_any
                          - previous_campaign_specific_clicked
                          - ecomm_bought_any
                          - ecomm_bought_product
                          - ecomm_bought_category
                          - ecomm_not_bought_any
                          - ecomm_abandoned_cart
                          - campaign_sent
                          - opened_email
                          - not_opened_email
                          - clicked_email
                          - not_clicked_email
                          - campaign_specific_clicked
                          - manual
                          - signup
                          - merge_changed
                          - group_add
                          - group_remove
                          - mandrill_sent
                          - mandrill_opened
                          - mandrill_clicked
                          - mandrill_any
                          - api
                          - goal
                          - annual
                          - birthday
                          - date
                          - date_added
                          - tag_add
                        action_description:
                          type: string
                          title: Delay Action Description
                          description: The user-friendly description of the action that triggers an Automation email.
                          example: subscribers purchase anything from your store
                          readOnly: true
                        full_description:
                          type: string
                          title: Full Delay Description
                          description: The user-friendly description of the delay and trigger action settings for an Automation email.
                          example: 1 day after subscribers purchase anything from your store
                          readOnly: true
                    create_time:
                      type: string
                      title: Create Time
                      format: date-time
                      description: The date and time the campaign was created in ISO 8601 format.
                      readOnly: true
                    start_time:
                      type: string
                      title: Start Time
                      format: date-time
                      description: The date and time the campaign was started in ISO 8601 format.
                      readOnly: true
                    archive_url:
                      type: string
                      title: Archive URL
                      description: The link to the campaign's archive version in ISO 8601 format.
                      readOnly: true
                    status:
                      type: string
                      title: Campaign Status
                      description: The current status of the campaign.
                      enum:
                      - save
                      - paused
                      - sending
                      readOnly: true
                    emails_sent:
                      type: integer
                      title: Emails Sent
                      description: The total number of emails sent for this campaign.
                      readOnly: true
                    send_time:
                      type: string
                      title: Send Time
                      format: date-time
                      description: ' The date and time a campaign was sent in ISO 8601 format'
                      readOnly: true
                    content_type:
                      type: string
                      title: Content Type
                      description: How the campaign's content is put together ('template', 'drag_and_drop', 'html', 'url').
                      readOnly: true
                    needs_block_refresh:
                      type: boolean
                      title: Needs Block Refresh
                      description: Determines if the automation email needs its blocks refreshed by opening the web-based campaign editor.
                      readOnly: true
                      example: true
                    has_logo_merge_tag:
                      type: boolean
                      title: Has Logo Merge Tag
                      description: Determines if the campaign contains the *|BRAND:LOGO|* merge tag.
                      readOnly: true
                      example: true
                    recipients:
                      type: object
                      title: List
                      description: List settings for the campaign.
                      properties:
                        list_id:
                          type: string
                          title: List ID
                          description: The unique list id.
                        list_is_active:
                          type: boolean
                          title: List Status
                          description: The status of the list used, namely if it's deleted or disabled.
                          readOnly: true
                        list_name:
                          type: string
                          title: List Name
                          description: The name of the list.
                          readOnly: true
                        segment_text:
                          type: string
                          title: Segment Text
                          description: A description of the [segment](https://mailchimp.com/help/getting-started-with-groups/) used for the campaign. Formatted as a string marked up with HTML.
                          readOnly: true
                        recipient_count:
                          type: integer
                          title: Recipient Count
                          description: Count of the recipients on the associated list. Formatted as an integer.
                          readOnly: true
                        segment_opts:
                          type: object
                          title: Segment Options
                          description: An object representing all segmentation options. This object should contain a `saved_segment_id` to use an existing segment, or you can create a new segment by including both `match` and `conditions` options.
                          properties:
                            saved_segment_id:
                              type: integer
                              title: Saved Segment ID
                              description: The id for an existing saved segment.
                            prebuilt_segment_id:
                              type: string
                              title: Prebuilt Segment Id
                              description: The prebuilt segment id, if a prebuilt segment has been designated for this campaign.
                              example: subscribers-female
                            match:
                              type: string
                              title: Match Type
                              description: Segment match type.
                              enum:
                              - any
                              - all
                            conditions:
                              type: array
                              title: Segment Type
                              description: Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas).
                              items:
                                x-discriminator:
                                  type: string
                                  propertyName: condition_type
                                x-oneOf:
                                - type: object
                                  title: Aim Segment
                                  description: Segment by interaction with a specific campaign.
                                  properties:
                                    condition_type:
                                      type: string
                                      x-value: Aim
                                      enum:
                                      - Aim
                                    field:
                                      type: string
                                      enum:
                                      - aim
                                      title: Segment Field
                                      description: Segment by interaction with a specific campaign.
                                      example: aim
                                    op:
                                      type: string
                                      enum:
                                      - open
                                      - click
                                      - sent
                                      - noopen
                                      - noclick
                                      - nosent
                                      title: Segment Operator
                                      description: 'The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn''t open, didn''t click, or was not sent.'
                                      example: open
                                    value:
                                      type: string
                                      title: Segment Data
                                      description: Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns.
                                      example: any
                                - type: object
                                  title: Automation Segment
                                  description: Segment by interaction with an Automation workflow.
                                  required:
                                  - field
                                  - op
                                  - value
                                  properties:
                                    condition_type:
                                      type: string
                                      x-value: Automation
                                      enum:
                                      - Automation
                                    field:
                                      type: string
                                      enum:
                                      - automation
                                      title: Segment Field
                                      description: Segment by interaction with an Automation workflow.
                                      example: automation
                                    op:
                                      type: string
                                      enum:
                                      - started
                                      - completed
                                      - not_started
                                      - not_completed
                                      title: Segment Operator
                                      description: 'The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow.'
                                      example: started
                                    value:
                                      type: string
                                      title: Segment Data
                                      description: The web id for the automation workflow to segment against.
                                      example: '2135217'
                                - type: object
                                  title: Poll Activity Segment
                                  description: Segment by poll activity.
                                  required:
                                  - field
                                  - op
                                  - value
                                  properties:
                                    condition_type:
                                      type: string
                                      x-value: CampaignPoll
                                      enum:
                                      - CampaignPoll
                                    field:
                                      type: string
                                      enum:
                                      - poll
                                      title: Segment Field
                                      description: Segment by poll activity.
                                      example: poll
                                    op:
                                      type: string
                                      enum:
                                      - member
                                      - notmember
                                      title: Segment Operator
                                      description: Members have/have not interacted with a specific poll in a Mailchimp email.
                                      example: member
                                    value:
                                      type: number
                                      title: Segment Operator
                                      description: The id for the poll.
                                      example: 409
                                - type: object
                                  title: Conversation Segment
                                  description: Segment by interaction with a campaign via Conversations.
                                  required:
                                  - field
                                  - op
                                  - value
                                  properties:
                                    condition_type:
                                      type: string
                                      x-value: Conversation
                                      enum:
                                      - Conversation
                                    field:
                                      type: string
                                      enum:
                                      - conversation
                                      title: Segment Field
                                      description: Segment by interaction with a campaign via Conversations.
                                      example: conversation
                                    op:
                                      type: string
                                      enum:
                                      - member
                                      - notmember
                                      title: Segment Operator
                                      description: 'The status of a member''s interaction with a conversation. One of the following: has replied or has not replied.'
                                      example: member
                                    value:
                                      type: string
                                      title: Segment Data
                                      description: The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns.
                                      example: any
                                - type: object
                                  title: Date Segment
                                  description: Segment by a specific date field.
                                  required:
                                  - field
                                  - op
                                  - value
                                  properties:
                                    condition_type:
                                      type: string
                                      x-value: Date
                                      enum:
                                      - Date
                                    field:
                                      type: string
                                      enum:
                                      - timestamp_opt
                                      - info_changed
                                      - ecomm_date
                                      title: Segment Field
                                      description: 'The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase.'
                                      example: timestamp_opt
                                    op:
                                      type: string
                                      enum:
                                      - greater
                                      - less
                                      - is
                                      - not
                                      - blank
                                      - blank_not
                                      - within
                                      - notwithin
                                      title: Segment Operator
                                      description: 'When the event took place:  Before, after, is a specific date, is not a specific date, is blank, or is not blank.'
                                      example: greater
                                    value:
                                      type: string
                                      title: Segment Data
                                      description: 'What type of data to segment on: a specific date, a specific campaign, or the last campaign sent.'
                                      example: date
                                    extra:
                                      type: string
                                      title: Segment Extra Value
                                      description: When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign.
                                      example: '2015-01-30'
                                - type: object
                                  title: Email Client Segment
                                  description: Segment by use of a particular email client.
                                  required:
                                  - field
                                  - op
                                  - value
                                  properties:
                                    condition_type:
                                      type: string
                                      x-value: EmailClient
                                      enum:
                                      - EmailClient
                                    field:
                                      type: string
                                      enum:
                                      - email_client
                                      title: Segment Field
                                      description: Segment by use of a particular email client.
                                      example: email_client
                                    op:
                                      type: string
                                      enum:
                                      - client_is
                                      - client_not
                                      title: Segment Operator
                                      description: The operation to determine whether we select clients that match the value, or clients that do not match the value.
                                      example: client_is
                                    value:
                                      type: string
                                      title: Segment Data
                                      description: The name of the email client.
                                      example: Gmail
                                - type: object
                                  title: Language Segment
                                  description: Segment by language.
                                  required:
                                  - field
                                  - op
                                  - value
                                  properties:
                                    condition_type:
                                      type: string
                                      x-value: Language
                                      enum:
                                      - Language
                                    field:
                                      type: string
                                      enum:
                                      - language
                                      title: Segment Field
                                      description: Segmenting based off of a subscriber's language.
                                      example: language
                                    op:
                                      type: string
                                      enum:
                                      - is
                                      - not
                                      title: Segment Operator
                                      description: Whether the member's language is or is not set to a specific language.
                                      example: is
                                    value:
                                      type: string
                                      title: Segment Data
                                      description: A two-letter language identifier.
                                      example: en
                                - type: object
                                  title: Member Rating Segment
                                  description: Segment by member rating.
                                  required:
                                  - field
                                  - op
                                  - value
                                  properties:
                                    condition_type:
                                      type: string
                                      x-value: MemberRating
 

# --- truncated at 32 KB (367 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mailchimp/refs/heads/main/openapi/mailchimp-emails-api-openapi.yml