Mailchimp Automations API

swagger: '2.0'
info:
  version: 3.0.55
  title: Mailchimp Marketing Abuse Automations 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: Automations
paths:
  /automations:
    get:
      summary: Mailchimp List Automations
      description: Get a summary of an account's classic automations.
      operationId: getAutomations
      parameters:
      - 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
      - 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: before_create_time
        x-title: Before Create Time
        in: query
        description: 'Restrict the response to automations created before this time. Uses the ISO 8601 time format: 2015-10-21T15:41:36+00:00.'
        type: string
        format: date-time
        required: false
        example: example_value
      - name: since_create_time
        x-title: Since Create Time
        in: query
        description: 'Restrict the response to automations created after this time. Uses the ISO 8601 time format: 2015-10-21T15:41:36+00:00.'
        type: string
        format: date-time
        required: false
        example: example_value
      - name: before_start_time
        x-title: Before Start Time
        in: query
        description: 'Restrict the response to automations started before this time. Uses the ISO 8601 time format: 2015-10-21T15:41:36+00:00.'
        type: string
        format: date-time
        required: false
        example: example_value
      - name: since_start_time
        x-title: Since Start Time
        in: query
        description: 'Restrict the response to automations started after this time. Uses the ISO 8601 time format: 2015-10-21T15:41:36+00:00.'
        type: string
        format: date-time
        required: false
        example: example_value
      - name: status
        x-title: Status
        in: query
        description: Restrict the results to automations with the specified status.
        required: false
        type: string
        enum:
        - save
        - paused
        - sending
        example: example_value
      responses:
        '200':
          description: ''
          schema:
            type: object
            description: An array of objects, each representing an Automation workflow.
            properties:
              automations:
                type: array
                items:
                  type: object
                  title: Automation Workflow
                  description: A summary of an individual Automation workflow's settings and content.
                  properties:
                    id:
                      type: string
                      title: Automation Campaign ID
                      description: A string that identifies the Automation.
                      readOnly: true
                    create_time:
                      type: string
                      title: Create Time
                      format: date-time
                      description: The date and time the Automation was created in ISO 8601 format.
                      readOnly: true
                    start_time:
                      type: string
                      title: Start Time
                      format: date-time
                      description: The date and time the Automation was started in ISO 8601 format.
                      readOnly: true
                    status:
                      type: string
                      title: Automation Status
                      description: The current status of the Automation.
                      enum:
                      - save
                      - paused
                      - sending
                      readOnly: true
                    emails_sent:
                      type: integer
                      title: Emails Sent
                      description: The total number of emails sent for the Automation.
                      readOnly: true
                    recipients:
                      type: object
                      title: List
                      description: List settings for the Automation.
                      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: List Name.
                        segment_opts:
                          type: object
                          title: Segment Options
                          description: An object representing all segmentation options.
                          properties:
                            saved_segment_id:
                              type: integer
                              title: Saved Segment ID
                              description: The id for an existing saved segment.
                            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
                                      enum:
                                      - MemberRating
                                    field:
                                      type: string
                                      enum:
                                      - rating
                                      title: Segment Field
                                      description: Segment by member rating.
                                      example: rating
                                    op:
                                      type: string
                                      enum:
                                      - is
                                      - not
                                      - greater
                                      - less
                                      title: Segment Operator
                                      description: Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number.
                                      example: greater
                                    value:
                                      type: number
                                      title: Segment Operator
                                      description: The star rating number to segment against.
                                      example: 4
                                - type: object
                                  title: Signup Source Segment
                                  description: Segment by signup source.
                                  required:
                                  - field
                                  - condition_type
                                  - op
                                  properties:
                                    condition_type:
                                      type: string
                                      enum:
                                      - SignupSource
                                      x-value: SignupSource
                                      title: Type
                                    field:
                                      type: string
                                      enum:
                                      - source
                                      title: Segment Field
                                      example: source
                                    op:
                                      type: string
                                      enum:
                                      - source_is
                                      - source_not
                                      title: Segment Operator
                                      description: Whether the member's signup source was/was not a particular value.
                                      example: source_is
                                    value:
                                      type: string
                                      title: Segment Data
                                      description: The signup source.
                                      example: List Import
                                - type: object
                                  title: Survey Monkey Segment
                                  description: Segment by interaction with a SurveyMonkey survey.
                                  required:
                                  - field
                                  - op
                                  - value
                                  properties:
                                    condition_type:
                                      type: string
                                      x-value: SurveyMonkey
                                      enum:
                                      - SurveyMonkey
                                    field:
                                      type: string
                                      enum:
                                      - survey_monkey
                                      title: Segment Field
                                      description: Segment by interaction with a SurveyMonkey survey.
                                      example: survey_monkey
                                    op:
                                      type: string
                                      enum:
                                      - started
                                      - completed
                                      - not_started
                                      - not_completed
                                      title: Segment Operator
                                      description: 'The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey.'
                                      example: started
                                    value:
                                      type: string
                                      title: Survey ID
                                      description: The unique ID of the survey monkey survey.
                                      example: '32179586'
                                - type: object
                                  title: VIP Segment
                                  description: Segment by VIP status.
                                  required:
                                  - field
                                  - op
                                  properties:
                                    condition_type:
                                      type: string
                                      x-value: VIP
                                      enum:
                                      - VIP
                                    field:
                                      type: string
                                      enum:
                                      - gmonkey
                                      title: Segment Field
                                      description: Segment by VIP status.
                                      example: gmonkey
                                    op:
                                      type: string
                                      enum:
                                      - member
                                      - notmember
                                      title: Segment Operator
                                      description: Whether the member is or is not marked as VIP.
                                      example: member
                                - type: object
                                  title: Interests Segment
                                  description: Segment by an interest group merge field.
                                  properties:
                                    condition_type:
                                      type: string
                                      x-value: Interests
                                      enum:
                                      - Interests
                                    field:
                                      type: string
                                      title: Segment Field
                                      description: Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'.
                                      example: interests-123
                                    op:
                                      type: string
                                      enum:
                                      - interestcontains
                                      - interestcontainsall
                                      - interestnotcontains
                                      title: Segment Operator
                                      description: Whether the member is a part of one, all, or none of the groups.
                                      example: interestcontains
                                    value:
                                      type: array
                                      title: Segment Value
                                      description: An array containing strings, each representing a group id.
                                      items:
                                        type: string
                                        example:
                                        - '44401'
                                        - '44405'
                                        - '44409'
                                - type: object
                                  title: Ecommerce Category Segment
                                  description: Segment by purchases in specific items or categories.
                                  properties:
                                    condition_type:
                                      type: string
                                      x-value: EcommCategory
                                      enum:
                                      - EcommCategory
                                    field:
                                      type: string
                                      enum:
                                      - ecomm_cat
                                      - ecomm_prod
                                      title: Segment Field
                                      description: Segment by purchases in specific items or categories.
                                      example: ecomm_cat
                                    op:
                                      type: string
                                      enum:
                                      - is
                                      - not
                                      -

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