Mailchimp
Mailchimp File Manager API

The File Manager API from Mailchimp — 2 operation(s) for file manager.
Documentation GitHub OpenAPI
OpenAPI Specification

swagger: '2.0'
info:
  version: 3.0.55
  title: Mailchimp Marketing Abuse File Manager 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: File Manager
paths:
  /file-manager/files/{file_id}:
    get:
      summary: Mailchimp Get File
      description: Get information about a specific file in the File Manager.
      operationId: getFileManagerFilesId
      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: file_id
        x-title: File ID
        type: string
        required: true
        description: The unique id for the File Manager file.
        example: '500123'
      responses:
        '200':
          description: ''
          schema:
            type: object
            title: Gallery File
            description: An individual file listed in the File Manager.
            properties:
              id:
                type: integer
                title: File ID
                description: The unique id of the file.
                readOnly: true
              folder_id:
                type: integer
                title: Folder ID
                description: The id of the folder.
              type:
                enum:
                - image
                - file
                type: string
                title: File Type
                description: The type of file in the File Manager.
                readOnly: true
              name:
                type: string
                title: File Name
                description: The name of the file.
              full_size_url:
                type: string
                title: File URL
                description: The url of the full-size file.
                format: uri
                readOnly: true
              thumbnail_url:
                type: string
                title: Thumbnail URL
                description: The url of the thumbnail preview.
                format: uri
                readOnly: true
              size:
                type: integer
                title: File Size
                description: The size of the file in bytes.
                readOnly: true
              created_at:
                type: string
                title: Created Date
                description: The date and time a file was added to the File Manager in ISO 8601 format.
                format: date-time
                readOnly: true
              created_by:
                type: string
                title: Created By
                description: The username of the profile that uploaded the file.
                readOnly: true
              width:
                type: integer
                title: Image Width
                description: The width of the image.
                readOnly: true
              height:
                type: integer
                title: Image Height
                description: The height of an image.
                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:
      - File Manager
      x-custom-config:
        methodNameSnake: get_file
        methodNameCamel: getFile
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    patch:
      summary: Mailchimp Update File
      description: Update a file in the File Manager.
      operationId: patchFileManagerFilesId
      parameters:
      - in: path
        name: file_id
        x-title: File ID
        type: string
        required: true
        description: The unique id for the File Manager file.
        example: '500123'
      - name: body
        in: body
        required: true
        schema:
          type: object
          title: Gallery File
          description: An individual file listed in the File Manager.
          properties:
            folder_id:
              type: integer
              title: Folder ID
              description: The id of the folder. Setting `folder_id` to `0` will remove a file from its current folder.
            name:
              type: string
              title: File Name
              description: The name of the file.
        description: ''
        example: example_value
      responses:
        '200':
          description: ''
          schema:
            type: object
            title: Gallery File
            description: An individual file listed in the File Manager.
            properties:
              id:
                type: integer
                title: File ID
                description: The unique id of the file.
                readOnly: true
              folder_id:
                type: integer
                title: Folder ID
                description: The id of the folder.
              type:
                enum:
                - image
                - file
                type: string
                title: File Type
                description: The type of file in the File Manager.
                readOnly: true
              name:
                type: string
                title: File Name
                description: The name of the file.
              full_size_url:
                type: string
                title: File URL
                description: The url of the full-size file.
                format: uri
                readOnly: true
              thumbnail_url:
                type: string
                title: Thumbnail URL
                description: The url of the thumbnail preview.
                format: uri
                readOnly: true
              size:
                type: integer
                title: File Size
                description: The size of the file in bytes.
                readOnly: true
              created_at:
                type: string
                title: Created Date
                description: The date and time a file was added to the File Manager in ISO 8601 format.
                format: date-time
                readOnly: true
              created_by:
                type: string
                title: Created By
                description: The username of the profile that uploaded the file.
                readOnly: true
              width:
                type: integer
                title: Image Width
                description: The width of the image.
                readOnly: true
              height:
                type: integer
                title: Image Height
                description: The height of an image.
                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:
      - File Manager
      x-custom-config:
        methodNameSnake: update_file
        methodNameCamel: updateFile
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      summary: Mailchimp Delete File
      description: Remove a specific file from the File Manager.
      operationId: deleteFileManagerFilesId
      parameters:
      - in: path
        name: file_id
        x-title: File ID
        type: string
        required: true
        description: The unique id for the File Manager file.
        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:
      - File Manager
      x-custom-config:
        methodNameSnake: delete_file
        methodNameCamel: deleteFile
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /file-manager/folders/{folder_id}:
    get:
      summary: Mailchimp Get Folder
      description: Get information about a specific folder in the File Manager.
      operationId: getFileManagerFoldersId
      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: folder_id
        x-title: Folder ID
        type: string
        required: true
        description: The unique id for the File Manager folder.
        example: '500123'
      responses:
        '200':
          description: ''
          schema:
            type: object
            title: Gallery Folder
            description: An individual folder listed in the File Manager.
            properties:
              id:
                type: integer
                title: Folder ID
                description: The unique id for the folder.
                readOnly: true
              name:
                type: string
                title: Folder Name
                description: The name of the folder.
              file_count:
                type: integer
                title: File Count
                description: The number of files in the folder.
                readOnly: true
              created_at:
                type: string
                title: Created Date
                format: date-time
                description: The date and time a file was added to the File Manager in ISO 8601 format.
                readOnly: true
              created_by:
                type: string
                title: Created By
                description: The username of the profile that created the folder.
                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:
      - File Manager
      x-custom-config:
        methodNameSnake: get_folder
        methodNameCamel: getFolder
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    patch:
      summary: Mailchimp Update Folder
      description: Update a specific File Manager folder.
      operationId: patchFileManagerFoldersId
      parameters:
      - in: path
        name: folder_id
        x-title: Folder ID
        type: string
        required: true
        description: The unique id for the File Manager folder.
        example: '500123'
      - name: body
        in: body
        required: true
        schema:
          type: object
          title: Gallery Folder
          description: An individual folder listed in the File Manager.
          required:
          - name
          properties:
            name:
              type: string
              title: Folder Name
              description: The name of the folder.
        description: ''
        example: example_value
      responses:
        '200':
          description: ''
          schema:
            type: object
            title: Gallery Folder
            description: An individual folder listed in the File Manager.
            properties:
              id:
                type: integer
                title: Folder ID
                description: The unique id for the folder.
                readOnly: true
              name:
                type: string
                title: Folder Name
                description: The name of the folder.
              file_count:
                type: integer
                title: File Count
                description: The number of files in the folder.
                readOnly: true
              created_at:
                type: string
                title: Created Date
                format: date-time
                description: The date and time a file was added to the File Manager in ISO 8601 format.
                readOnly: true
              created_by:
                type: string
                title: Created By
                description: The username of the profile that created the folder.
                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:
      - File Manager
      x-custom-config:
        methodNameSnake: update_folder
        methodNameCamel: updateFolder
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      summary: Mailchimp Delete Folder
      description: Delete a specific folder in the File Manager.
      operationId: deleteFileManagerFoldersId
      parameters:
      - in: path
        name: folder_id
        x-title: Folder ID
        type: string
        required: true
        description: The unique id for the File Manager folder.
        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
                descr

# --- truncated at 32 KB (59 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mailchimp/refs/heads/main/openapi/mailchimp-file-manager-api-openapi.yml
Mailchimp File Manager API

Documentation

Specifications

Schemas & Data

Other Resources

OpenAPI Specification
