Mailchimp customer Journeys API

openapi: 3.2.0
info:
  contact:
    email: apihelp@mailchimp.com
    name: Mailchimp API Support
  description: 'Whether you’re managing your own campaigns, providing Mailchimp services to your customers or clients, or writing a mobile app, the Mailchimp API has features to manage and sync your contact data.


    Audiences are at the core of sending campaigns with Mailchimp. You can use the API to set up an audience and add contacts to that audience; you can then organize those contacts with tags or segment them by activity with events.


    The API can also be a source of data for your application. Webhooks collect and transmit information about your audience to you in near real time. And if you’re selling products on an external store, you can integrate your audience behavior using Mailchimp’s E-commerce features.


    You can also use the API to handle data in different ways for different purposes. If you are syncing a large amount of data with Mailchimp, you can use batches to avoid hitting the API request limits. For building integrations that let other users access data from their own Mailchimp accounts, you should authenticate with OAuth 2. And if you’re developing an app for iOS or Android, the Mobile SDK provides an easy way to work with a mobile-focused subset of the API’s functionality.'
  summary: Manage audiences, integrate your data, and send timely, relevant email campaigns.
  termsOfService: https://mailchimp.com/legal/api_use/
  title: Mailchimp Customer Journeys API
  version: 0.1.0-dev
servers:
- description: Mailchimp API
  url: https://api.mailchimp.com
security:
- bearerToken: []
- oauth2: []
tags:
- name: customer-journeys
paths:
  /3.0/customer-journeys/journeys/{journey_id}/steps/{step_id}/actions/trigger:
    post:
      description: A step trigger in an Automation flow. To use it, create a starting point or step from the Automation flow builder in the app using the Customer Journeys API condition. We’ll provide a url during the process that includes the {journey_id} and {step_id}. You’ll then be able to use this endpoint to trigger the condition for the posted contact.
      operationId: postCustomerJourneysJourneysIdStepsIdActionsTrigger
      parameters:
      - description: The id for the flow.
        in: path
        name: journey_id
        required: true
        schema:
          type: integer
          x-title: Flow ID
        x-title: Flow ID
      - description: The id for the Step.
        in: path
        name: step_id
        required: true
        schema:
          type: integer
          x-title: Step ID
        x-title: Step ID
      requestBody:
        content:
          application/json:
            schema:
              description: Information about subscribers in an Automation flow's audience.
              properties:
                email_address:
                  description: The list member's email address.
                  title: Email Address
                  type: string
              required:
              - email_address
              title: Subscriber in Automation flow's audience
              type: object
        required: true
      responses:
        '204':
          content: {}
          description: Empty Response
        default:
          content:
            application/problem+json:
              schema:
                description: 'An error generated by the Mailchimp API. The response conforms to [RFC 9457: Problem Details for HTTP APIs](https://www.rfc-editor.org/rfc/rfc9457).'
                properties:
                  detail:
                    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).
                    examples:
                    - The requested resource could not be found.
                    title: Error Message
                    type: string
                  instance:
                    description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.
                    examples:
                    - 995c5cb0-3280-4a6e-808b-3b096d0bb219
                    title: Instance ID
                    type: string
                  status:
                    description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
                    examples:
                    - 404
                    title: HTTP Status Code
                    type: integer
                  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.
                    examples:
                    - Resource Not Found
                    title: Error Title
                    type: string
                  type:
                    description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
                    examples:
                    - https://mailchimp.com/developer/marketing/docs/errors/
                    title: Problem Type
                    type: string
                required:
                - detail
                - instance
                - status
                - title
                - type
                title: Problem Detail Document
                type: object
          description: An error generated by the Mailchimp API.
      summary: Automation flows API trigger for a contact
      tags:
      - customer-journeys
      x-custom-config:
        methodNameCamel: trigger
        methodNameSnake: trigger
  /customer-journeys/journeys/{journey_id}/steps/{step_id}/actions/trigger:
    post:
      summary: Customer Journeys API trigger for a contact
      description: A step trigger in an Automation flow. To use it, create a starting point or step from the Automation flow builder in the app using the Customer Journey API condition. We’ll provide a url during the process that includes the {journey_id} and {step_id}. You’ll then be able to use this endpoint to trigger the condition for the posted contact.
      operationId: postCustomerJourneysJourneysIdStepsIdActionsTrigger
      parameters:
      - in: path
        name: journey_id
        x-title: Flow ID
        required: true
        description: The id for the flow.
        schema:
          type: integer
      - in: path
        name: step_id
        x-title: Step ID
        required: true
        description: The id for the Step.
        schema:
          type: integer
      responses:
        '204':
          description: An empty response
          content:
            application/json:
              schema:
                description: Empty Response
            application/problem+json:
              schema:
                description: Empty Response
        default:
          description: An error generated by the Mailchimp API.
          content:
            application/json:
              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
            application/problem+json:
              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:
      - customer Journeys
      x-custom-config:
        methodNameSnake: trigger
        methodNameCamel: trigger
      requestBody:
        content:
          application/json:
            schema:
              type: object
              title: Subscriber in Automation flow's audience
              description: Information about subscribers in a Automation flows's audience.
              required:
              - email_address
              properties:
                email_address:
                  type: string
                  title: Email Address
                  description: The list member's email address.
        required: true
components:
  securitySchemes:
    bearerToken:
      description: Authorization using a Mailchimp API key (a.k.a. Bearer token)
      scheme: Bearer
      type: http
    oauth2:
      description: Authorization using OAuth
      flows:
        authorizationCode:
          authorizationUrl: https://login.mailchimp.com/oauth2/authorize
          scopes: {}
          tokenUrl: https://login.mailchimp.com/oauth2/token
      type: oauth2
    basicAuth:
      type: http
      scheme: basic