Mailchimp Feedback API

swagger: '2.0'
info:
  version: 3.0.55
  title: Mailchimp Marketing Abuse Feedback 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: Feedback
paths:
  /campaigns/{campaign_id}/feedback:
    get:
      summary: Mailchimp List Campaign Feedback
      description: Get team feedback while you're working together on a Mailchimp campaign.
      operationId: getCampaignsIdFeedback
      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: campaign_id
        x-title: Campaign ID
        type: string
        required: true
        description: The unique id for the campaign.
        example: '500123'
      responses:
        '200':
          description: ''
          schema:
            type: object
            title: Campaign Reports
            description: A summary of the comment feedback for a specific campaign.
            properties:
              feedback:
                type: array
                items:
                  type: object
                  title: Campaign Feedback
                  description: A specific feedback message from a specific campaign.
                  required:
                  - message
                  properties:
                    feedback_id:
                      type: integer
                      title: Feedback ID
                      description: The individual id for the feedback item.
                      readOnly: true
                    parent_id:
                      type: integer
                      title: Parent ID
                      description: If a reply, the id of the parent feedback item.
                      readOnly: true
                    block_id:
                      type: integer
                      title: Block ID
                      description: The block id for the editable block that the feedback addresses.
                    message:
                      type: string
                      title: Message
                      description: The content of the feedback.
                    is_complete:
                      type: boolean
                      title: Complete
                      description: The status of feedback.
                    created_by:
                      type: string
                      title: Created By
                      description: The login name of the user who created the feedback.
                      readOnly: true
                    created_at:
                      type: string
                      title: Created At
                      description: The date and time the feedback item was created in ISO 8601 format.
                      format: date-time
                      readOnly: true
                    updated_at:
                      type: string
                      title: Updated At
                      description: The date and time the feedback was last updated in ISO 8601 format.
                      format: date-time
                      readOnly: true
                    source:
                      type: string
                      title: Source
                      description: The source of the feedback.
                      enum:
                      - api
                      - email
                      - sms
                      - web
                      - ios
                      - android
                      readOnly: true
                    campaign_id:
                      type: string
                      title: Campaign ID
                      description: The unique id for the campaign.
                      readOnly: true
                    _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
                title: Campaign Feedback
                description: A collection of feedback items for a campaign.
              campaign_id:
                type: string
                title: Campaign ID
                description: The unique id for the campaign.
                readOnly: true
              total_items:
                type: integer
                title: Item Count
                description: The total number of items matching the query regardless of pagination.
                readOnly: true
              _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:
      - Feedback
      x-custom-config:
        methodNameSnake: get_feedback
        methodNameCamel: getFeedback
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      summary: Mailchimp Add Campaign Feedback
      description: Add feedback on a specific campaign.
      operationId: postCampaignsIdFeedback
      parameters:
      - in: path
        name: campaign_id
        x-title: Campaign ID
        type: string
        required: true
        description: The unique id for the campaign.
        example: '500123'
      - in: body
        name: body
        description: ''
        required: true
        schema:
          type: object
          title: Campaign Feedback
          description: A specific feedback message from a specific campaign.
          required:
          - message
          properties:
            block_id:
              type: integer
              title: Block ID
              description: The block id for the editable block that the feedback addresses.
            message:
              type: string
              title: Message
              description: The content of the feedback.
            is_complete:
              type: boolean
              title: Complete
              description: The status of feedback.
        example: example_value
      responses:
        '200':
          description: ''
          schema:
            type: object
            title: Campaign Feedback
            description: A specific feedback message from a specific campaign.
            properties:
              feedback_id:
                type: integer
                title: Feedback ID
                description: The individual id for the feedback item.
                readOnly: true
              parent_id:
                type: integer
                title: Parent ID
                description: If a reply, the id of the parent feedback item.
                readOnly: true
              block_id:
                type: integer
                title: Block ID
                description: The block id for the editable block that the feedback addresses.
              message:
                type: string
                title: Message
                description: The content of the feedback.
              is_complete:
                type: boolean
                title: Complete
                description: The status of feedback.
              created_by:
                type: string
                title: Created By
                description: The login name of the user who created the feedback.
                readOnly: true
              created_at:
                type: string
                title: Created At
                description: The date and time the feedback item was created in ISO 8601 format.
                format: date-time
                readOnly: true
              updated_at:
                type: string
                title: Updated At
                description: The date and time the feedback was last updated in ISO 8601 format.
                format: date-time
                readOnly: true
              source:
                type: string
                title: Source
                description: The source of the feedback.
                enum:
                - api
                - email
                - sms
                - web
                - ios
                - android
                readOnly: true
              campaign_id:
                type: string
                title: Campaign ID
                description: The unique id for the campaign.
                readOnly: true
              _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:
      - Feedback
      x-custom-config:
        methodNameSnake: add_feedback
        methodNameCamel: addFeedback
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /campaigns/{campaign_id}/feedback/{feedback_id}:
    get:
      summary: Mailchimp Get Campaign Feedback Message
      description: Get a specific feedback message from a campaign.
      operationId: getCampaignsIdFeedbackId
      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: campaign_id
        x-title: Campaign ID
        type: string
        required: true
        description: The unique id for the campaign.
        example: '500123'
      - in: path
        name: feedback_id
        x-title: Feedback ID
        type: string
        required: true
        description: The unique id for the feedback message.
        example: '500123'
      responses:
        '200':
          description: ''
          schema:
            type: object
            title: Campaign Feedback
            description: A specific feedback message from a specific campaign.
            properties:
              feedback_id:
                type: integer
                title: Feedback ID
                description: The individual id for the feedback item.
                readOnly: true
              parent_id:
                type: integer
                title: Parent ID
                description: If a reply, the id of the parent feedback item.
                readOnly: true
              block_id:
                type: integer
                title: Block ID
                description: The block id for the editable block that the feedback addresses.
              message:
                type: string
                title: Message
                description: The content of the feedback.
              is_complete:
                type: boolean
                title: Complete
                description: The status of feedback.
              created_by:
                type: string
                title: Created By
                description: The login name of the user who created the feedback.
                readOnly: true
              created_at:
                type: string
                title: Created At
                description: The date and time the feedback item was created in ISO 8601 format.
                format: date-time
                readOnly: true
              updated_at:
                type: string
                title: Updated At
                description: The date and time the feedback was last updated in ISO 8601 format.
                format: date-time
                readOnly: true
              source:
                type: string
                title: Source
                description: The source of the feedback.
                enum:
                - api
                - email
                - sms
                - web
                - ios
                - android
                readOnly: true
              campaign_id:
                type: string
                title: Campaign ID
                description: The unique id for the campaign.
                readOnly: true
              _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:
      - Feedback
      x-custom-config:
        methodNameSnake: get_feedback_message
        methodNameCamel: getFeedbackMessage
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    patch:
      summary: Mailchimp Update Campaign Feedback Message
      description: Update a specific feedback message for a campaign.
      operationId: patchCampaignsIdFeedbackId
      parameters:
      - in: path
        name: campaign_id
        x-title: Campaign ID
        type: string
        required: true
        description: The unique id for the campaign.
        example: '500123'
      - in: path
        name: feedback_id
        x-title: Feedback ID
        type: string
        required: true
        description: The unique id for the feedback message.
        example: '500123'
      - in: body
        name: body
        description: ''
        required: true
        schema:
          type: object
          title: Campaign Feedback
          description: A specific feedback message from a specific campaign.
          properties:
            block_id:
              type: integer
              title: Block ID
              description: The block id for the editable block that the feedback addresses.
            message:
              type: string
              title: Message
              description: The content of the feedback.
            is_complete:
              type: boolean
              title: Complete
              description: The status of feedback.
        example: example_value
      responses:
        '200':
          description: ''
          schema:
            type: object
            title: Campaign Feedback
            description: A specific feedback message from a specific campaign.
            properties:
              feedback_id:
                type: integer
                title: Feedback ID
                description: The individual id for the feedback item.
                readOnly: true
              parent_id:
                type: integer
                title: Parent ID
                description: If a reply, the id of the parent feedback item.
                readOnly: true
              block_id:
                type: integer
                title: Block ID
                description: The block id for the editable block that the feedback addresses.
              message:
                type: string
                title: Message
                description: The content of the feedback.
              is_complete:
                type: boolean
                title: Complete
                description: The status of feedback.
              created_by:
                type: string
                title: Created By
                description: The login name of the user who created the feedback.
                readOnly: true
              created_at:
                type: string
                title: Created At
                description: The date and time the feedback item was created in ISO 8601 format.
                format: date-time
                readOnly: true
              updated_at:
                type: string
                title: Updated At
                description: The date and time the feedback was last updated in ISO 8601 format.
                format: date-time
                readOnly: true
              source:
                type: string
                title: Source
                description: The source of the feedback.
                enum:
                - api
                - email
                - sms
                - web
                - ios
                - android
                readOnly: true
              campaign_id:
                type: string
                title: Campaign ID
                description: The unique id for the campaign.
                readOnly: true
              _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
                 

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