Mailchimp Landing Pages API

swagger: '2.0'
info:
  version: 3.0.55
  title: Mailchimp Marketing Abuse Landing Pages 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: Landing Pages
paths:
  /landing-pages/{page_id}:
    get:
      summary: Mailchimp Get Landing Page Info
      description: Get information about a specific page.
      parameters:
      - name: fields
        x-title: Fields
        in: query
        description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
        required: false
        type: array
        collectionFormat: csv
        items:
          type: string
        example: example_value
      - name: exclude_fields
        x-title: Exclude Fields
        in: query
        description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
        required: false
        type: array
        collectionFormat: csv
        items:
          type: string
        example: example_value
      - in: path
        name: page_id
        x-title: Landing Page unique ID
        type: string
        required: true
        description: The unique id for the page.
        example: '500123'
      responses:
        '200':
          description: Landing Pages Instance
          schema:
            type: object
            title: Landing Page
            description: A summary of an individual landing page's settings and content.
            properties:
              id:
                type: string
                title: Landing Page ID
                description: A string that uniquely identifies this landing page.
                readOnly: true
                example: 030092c2e1f0
              name:
                type: string
                title: Landing Page Name
                description: The name of this landing page.
                readOnly: false
              title:
                type: string
                title: Landing Page title
                description: The title of this landing page seen in the browser's title bar.
                readOnly: false
              description:
                type: string
                title: Landing Page description
                description: The description of this landing page.
                readOnly: false
              template_id:
                type: integer
                title: Landing Page template_id
                description: The template_id of this landing page.
                readOnly: true
              status:
                type: string
                title: Landing Page status
                description: The status of this landing page.
                enum:
                - published
                - unpublished
                - draft
                readOnly: true
              list_id:
                type: string
                title: Landing Page list id
                description: The list's ID associated with this landing page.
                example: fde02ad86b
                readOnly: false
              store_id:
                type: string
                title: Store ID
                description: The ID of the store associated with this landing page.
                readOnly: false
              web_id:
                type: integer
                title: Landing Page Web ID
                description: The ID used in the Mailchimp web application.
              created_by_source:
                type: string
                title: Created By Source
                description: Created by mobile or web
                readOnly: true
              url:
                type: string
                title: Published url
                description: The url of the published landing page.
                readOnly: true
              created_at:
                type: string
                title: Created At
                description: The time this landing page was created.
                format: date-time
                readOnly: true
              published_at:
                type: string
                title: Published at
                description: The time this landing page was published.
                format: date-time
                readOnly: true
              unpublished_at:
                type: string
                title: Unpublished at
                description: The time this landing page was unpublished.
                format: date-time
                readOnly: true
              updated_at:
                type: string
                title: Updated_at
                description: The time this landing page was updated at.
                format: date-time
                readOnly: true
              tracking:
                type: object
                title: Tracking Settings
                description: The tracking settings applied to this landing page.
                properties:
                  track_with_mailchimp:
                    type: boolean
                    title: Track with Mailchimp
                    description: Use cookies to track unique visitors and calculate overall conversion rate. Learn more [here](https://mailchimp.com/help/use-track-mailchimp/).
                  enable_restricted_data_processing:
                    type: boolean
                    title: Enable restricted data processing
                    description: Google offers restricted data processing in connection with the California Consumer Privacy Act (CCPA) to restrict how Google uses certain identifiers and other data processed in the provision of its services. You can learn more about Google's restricted data processing within Google Ads [here](https://privacy.google.com/businesses/rdp/).
              _links:
                title: Links
                description: A list of link types and descriptions for the API schema documents.
                type: array
                items:
                  type: object
                  title: Resource Link
                  description: This object represents a link from the resource where it is found to another resource or action that may be performed.
                  properties:
                    rel:
                      type: string
                      title: Rel
                      description: As with an HTML 'rel' attribute, this describes the type of link.
                      readOnly: true
                    href:
                      type: string
                      title: Href
                      description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
                      readOnly: true
                    method:
                      type: string
                      title: Method
                      description: The HTTP method that should be used when accessing the URL defined in 'href'.
                      enum:
                      - GET
                      - POST
                      - PUT
                      - PATCH
                      - DELETE
                      - OPTIONS
                      - HEAD
                      readOnly: true
                    targetSchema:
                      type: string
                      title: Target Schema
                      description: For GETs, this is a URL representing the schema that the response should conform to.
                      readOnly: true
                    schema:
                      type: string
                      title: Schema
                      description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.
                      readOnly: true
                readOnly: true
        default:
          description: An error generated by the Mailchimp API.
          schema:
            type: object
            title: Problem Detail Document
            description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.
            required:
            - type
            - title
            - status
            - detail
            - instance
            properties:
              type:
                type: string
                title: Problem Type
                description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
                example: https://mailchimp.com/developer/marketing/docs/errors/
              title:
                type: string
                title: Error Title
                description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization.
                example: Resource Not Found
              status:
                type: integer
                title: HTTP Status Code
                description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
                example: 404
              detail:
                type: string
                title: Error Message
                description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors).
                example: The requested resource could not be found.
              instance:
                type: string
                title: Instance ID
                description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.
                example: 995c5cb0-3280-4a6e-808b-3b096d0bb219
      deprecated: false
      tags:
      - Landing Pages
      x-custom-config:
        methodNameSnake: get_page
        methodNameCamel: getPage
      operationId: getLandingPageId
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    patch:
      summary: Mailchimp Update Landing Page
      description: Update a landing page.
      parameters:
      - in: path
        name: page_id
        x-title: Landing Page unique ID
        type: string
        required: true
        description: The unique id for the page.
        example: '500123'
      - name: body
        in: body
        description: ''
        required: true
        schema:
          type: object
          title: Landing Page
          description: A summary of an individual page's properties.
          properties:
            name:
              type: string
              title: Landing Page Name
              description: The name of this landing page.
            title:
              type: string
              title: Landing Page title
              description: The title of this landing page seen in the browser's title bar.
            description:
              type: string
              title: Landing Page description
              description: The description of this landing page.
            store_id:
              type: string
              title: Store ID
              description: The ID of the store associated with this landing page.
            list_id:
              type: string
              title: Landing Page list id
              description: The list's ID associated with this landing page.
            tracking:
              type: object
              title: Tracking Settings
              description: The tracking settings applied to this landing page.
              properties:
                track_with_mailchimp:
                  type: boolean
                  title: Track with Mailchimp
                  description: Use cookies to track unique visitors and calculate overall conversion rate. Learn more [here](https://mailchimp.com/help/use-track-mailchimp/).
                enable_restricted_data_processing:
                  type: boolean
                  title: Enable restricted data processing
                  description: Google offers restricted data processing in connection with the California Consumer Privacy Act (CCPA) to restrict how Google uses certain identifiers and other data processed in the provision of its services. You can learn more about Google's restricted data processing within Google Ads [here](https://privacy.google.com/businesses/rdp/).
        example: example_value
      responses:
        '200':
          description: ''
          schema:
            type: object
            title: Landing Page
            description: A summary of an individual landing page's settings and content.
            properties:
              id:
                type: string
                title: Landing Page ID
                description: A string that uniquely identifies this landing page.
                readOnly: true
                example: 030092c2e1f0
              name:
                type: string
                title: Landing Page Name
                description: The name of this landing page.
                readOnly: false
              title:
                type: string
                title: Landing Page title
                description: The title of this landing page seen in the browser's title bar.
                readOnly: false
              description:
                type: string
                title: Landing Page description
                description: The description of this landing page.
                readOnly: false
              template_id:
                type: integer
                title: Landing Page template_id
                description: The template_id of this landing page.
                readOnly: true
              status:
                type: string
                title: Landing Page status
                description: The status of this landing page.
                enum:
                - published
                - unpublished
                - draft
                readOnly: true
              list_id:
                type: string
                title: Landing Page list id
                description: The list's ID associated with this landing page.
                example: fde02ad86b
                readOnly: false
              store_id:
                type: string
                title: Store ID
                description: The ID of the store associated with this landing page.
                readOnly: false
              web_id:
                type: integer
                title: Landing Page Web ID
                description: The ID used in the Mailchimp web application.
              created_by_source:
                type: string
                title: Created By Source
                description: Created by mobile or web
                readOnly: true
              url:
                type: string
                title: Published url
                description: The url of the published landing page.
                readOnly: true
              created_at:
                type: string
                title: Created At
                description: The time this landing page was created.
                format: date-time
                readOnly: true
              published_at:
                type: string
                title: Published at
                description: The time this landing page was published.
                format: date-time
                readOnly: true
              unpublished_at:
                type: string
                title: Unpublished at
                description: The time this landing page was unpublished.
                format: date-time
                readOnly: true
              updated_at:
                type: string
                title: Updated_at
                description: The time this landing page was updated at.
                format: date-time
                readOnly: true
              tracking:
                type: object
                title: Tracking Settings
                description: The tracking settings applied to this landing page.
                properties:
                  track_with_mailchimp:
                    type: boolean
                    title: Track with Mailchimp
                    description: Use cookies to track unique visitors and calculate overall conversion rate. Learn more [here](https://mailchimp.com/help/use-track-mailchimp/).
                  enable_restricted_data_processing:
                    type: boolean
                    title: Enable restricted data processing
                    description: Google offers restricted data processing in connection with the California Consumer Privacy Act (CCPA) to restrict how Google uses certain identifiers and other data processed in the provision of its services. You can learn more about Google's restricted data processing within Google Ads [here](https://privacy.google.com/businesses/rdp/).
              _links:
                title: Links
                description: A list of link types and descriptions for the API schema documents.
                type: array
                items:
                  type: object
                  title: Resource Link
                  description: This object represents a link from the resource where it is found to another resource or action that may be performed.
                  properties:
                    rel:
                      type: string
                      title: Rel
                      description: As with an HTML 'rel' attribute, this describes the type of link.
                      readOnly: true
                    href:
                      type: string
                      title: Href
                      description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
                      readOnly: true
                    method:
                      type: string
                      title: Method
                      description: The HTTP method that should be used when accessing the URL defined in 'href'.
                      enum:
                      - GET
                      - POST
                      - PUT
                      - PATCH
                      - DELETE
                      - OPTIONS
                      - HEAD
                      readOnly: true
                    targetSchema:
                      type: string
                      title: Target Schema
                      description: For GETs, this is a URL representing the schema that the response should conform to.
                      readOnly: true
                    schema:
                      type: string
                      title: Schema
                      description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.
                      readOnly: true
                readOnly: true
        default:
          description: An error generated by the Mailchimp API.
          schema:
            type: object
            title: Problem Detail Document
            description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.
            required:
            - type
            - title
            - status
            - detail
            - instance
            properties:
              type:
                type: string
                title: Problem Type
                description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
                example: https://mailchimp.com/developer/marketing/docs/errors/
              title:
                type: string
                title: Error Title
                description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization.
                example: Resource Not Found
              status:
                type: integer
                title: HTTP Status Code
                description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
                example: 404
              detail:
                type: string
                title: Error Message
                description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors).
                example: The requested resource could not be found.
              instance:
                type: string
                title: Instance ID
                description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.
                example: 995c5cb0-3280-4a6e-808b-3b096d0bb219
      tags:
      - Landing Pages
      x-custom-config:
        methodNameSnake: update_page
        methodNameCamel: updatePage
      operationId: patchLandingPageId
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      summary: Mailchimp Delete Landing Page
      description: Delete a landing page.
      parameters:
      - in: path
        name: page_id
        x-title: Landing Page unique ID
        type: string
        required: true
        description: The unique id for the page.
        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:
      - Landing Pages
      x-custom-config:
        methodNameSnake: delete_page
        methodNameCamel: deletePage
      operationId: deleteLandingPageId
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /landing-pages/{page_id}/actions/unpublish:
    post:
      summary: Mailchimp Unpublish Landing Page
      description: Unpublish a landing page that is in draft or has been published.
      parameters:
      - in: path
        name: page_id
        x-title: Landing Page unique ID
        type: string
        required: true
        description: The unique id for the page.
        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:
      - Landing Pages
      x-custom-config:
        methodNameSnake: unpublish_page
        methodNameCamel: unpublishPage
      operationId: postLandingPageIdActionsUnpublish
      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: Mana

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