File Manager Folders

Manage specific folders in the File Manager for your MailChimp account. The File Manager is a place to store images, documents, and other files you include or link to in your campaigns, templates, or signup forms.

Available methods

    • POST /file-manager/folders Create a new folder

      Create a new folder

      POST /file-manager/folders

      Create a new folder in the File Manager.

      Request body parameters

      name Type: String Title: Folder Name Read only: false The name of the folder.

      Response body parameters

      id Type: Integer Title: Folder ID Read only: true The unique id for the folder.
      name Type: String Title: Folder Name Read only: false The name of the folder.
      file_count Type: Integer Title: File Count Read only: true The number of files in the folder.
      created_at Type: String Title: Created Date Read only: true The date and time a file was added to the File Manager.
      created_by Type: String Title: Created By Read only: true The username of the profile that created the folder.
      _links Type: Array Title: Links Read only: true A list of link types and descriptions for the API schema documents.
      Show properties
      rel Type: String Title: Rel Read only: true As with an HTML ‘rel’ attribute, this describes the type of link.
      href Type: String Title: Href Read only: true This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
      method Type: String Title: Method Read only: true The HTTP method that should be used when accessing the URL defined in ‘href’.
      Possible Values:
      • GET
      • POST
      • PUT
      • PATCH
      • DELETE
      • OPTIONS
      • HEAD
      targetSchema Type: String Title: Target Schema Read only: true For GETs, this is a URL representing the schema that the response should conform to.
      schema Type: String Title: Schema Read only: true For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.

      Example request

      
      curl --request POST \
      --url 'https://usX.api.mailchimp.com/3.0/file-manager/folders' \
      --user 'anystring:apikey' \
      --header 'content-type: application/json' \
      --data '{"name":"Discarded Jokes"}' \
      --include
                                      

      Example response

      
      HTTP/1.1 200 OK
      Server: nginx
      Date: Thu, 12 May 2016 12:56:46 GMT
      Content-Type: application/json; charset=utf-8
      Content-Length: 1006
      Connection: keep-alive
      Vary: Accept-Encoding
      X-Request-Id: d9ebac39-144e-4c31-bf91-02a7c42426bd
      Link: <https://api.mailchimp.com/schema/3.0/FileManager/Folders/Instance.json>; rel="describedBy"
      
      {
        "id": 141,
        "name": "Discarded Jokes",
        "file_count": 0,
        "created_at": "2016-05-12T12:56:46+00:00",
        "created_by": "Freddie von Chimpenheimer",
        "_links": [
          {
            "rel": "self",
            "href": "https://usX.api.mailchimp.com/3.0/file-manager/folders/141",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/FileManager/Folders/Instance.json"
          },
          {
            "rel": "update",
            "href": "https://usX.api.mailchimp.com/3.0/file-manager/folders/141",
            "method": "PATCH",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/FileManager/Folders/Instance.json"
          },
          {
            "rel": "delete",
            "href": "https://usX.api.mailchimp.com/3.0/file-manager/folders/141",
            "method": "DELETE",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/FileManager/Folders/Instance.json"
          },
          {
            "rel": "parent",
            "href": "https://usX.api.mailchimp.com/3.0/file-manager/folders/",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/FileManager/Folders/Collection.json",
            "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/FileManager/Folders.json"
          }
        ]
      }
                                      

      Error response

      type Type: String Title: Problem Type Read only: false An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
      title Type: String Title: Error Title Read only: false 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.
      status Type: Integer Title: HTTP Status Code Read only: false The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
      detail Type: String Title: Error Message Read only: false A human-readable explanation specific to this occurrence of the problem. Learn more about errors.
      instance Type: String Title: Instance ID Read only: false A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.
    • GET /file-manager/folders Get a list of folders in the File Manager
      GET /file-manager/folders/{folder_id} Get information about a specific folder

      Get a list of folders in the File Manager

      GET /file-manager/folders

      Get a list of all folders in the File Manager.

      Query string parameters

      fields Type: Array Title: Fields Read only: false A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
      exclude_fields Type: Array Title: Exclude Fields Read only: false A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
      count Type: Integer Title: Count Read only: true The number of records to return. Default value is 10.
      offset Type: Integer Title: Offset Read only: false The number of records from a collection to skip. Iterating over large collections with this parameter can be slow. Default value is 0.
      created_by Type: String Title: Created By Read only: false The MailChimp account user who created the File Manager file.
      before_created_at Type: String Title: Before Created At Read only: false Restrict the response to files created before the set date.
      since_created_at Type: String Title: Since Created At Read only: false Restrict the response to files created after the set date.

      Response body parameters

      folders Type: Array Title: File Manager Folders Read only: false A list of all folders in the File Manager.
      Show properties
      id Type: Integer Title: Folder ID Read only: true The unique id for the folder.
      name Type: String Title: Folder Name Read only: false The name of the folder.
      file_count Type: Integer Title: File Count Read only: true The number of files in the folder.
      created_at Type: String Title: Created Date Read only: true The date and time a file was added to the File Manager.
      created_by Type: String Title: Created By Read only: true The username of the profile that created the folder.
      _links Type: Array Title: Links Read only: true A list of link types and descriptions for the API schema documents.
      Show properties
      rel Type: String Title: Rel Read only: true As with an HTML ‘rel’ attribute, this describes the type of link.
      href Type: String Title: Href Read only: true This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
      method Type: String Title: Method Read only: true The HTTP method that should be used when accessing the URL defined in ‘href’.
      Possible Values:
      • GET
      • POST
      • PUT
      • PATCH
      • DELETE
      • OPTIONS
      • HEAD
      targetSchema Type: String Title: Target Schema Read only: true For GETs, this is a URL representing the schema that the response should conform to.
      schema Type: String Title: Schema Read only: true For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.
      total_items Type: Integer Title: Item Count Read only: false The total number of items matching the query regardless of pagination.
      _links Type: Array Title: Links Read only: true A list of link types and descriptions for the API schema documents.
      Show properties
      rel Type: String Title: Rel Read only: true As with an HTML ‘rel’ attribute, this describes the type of link.
      href Type: String Title: Href Read only: true This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
      method Type: String Title: Method Read only: true The HTTP method that should be used when accessing the URL defined in ‘href’.
      Possible Values:
      • GET
      • POST
      • PUT
      • PATCH
      • DELETE
      • OPTIONS
      • HEAD
      targetSchema Type: String Title: Target Schema Read only: true For GETs, this is a URL representing the schema that the response should conform to.
      schema Type: String Title: Schema Read only: true For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.

      Example request

      
      curl --request GET \
      --url 'https://usX.api.mailchimp.com/3.0/file-manager/folders' \
      --user 'anystring:apikey' \
      --include
                                      

      Example response

      
      HTTP/1.1 200 OK
      Server: nginx
      Content-Type: application/json; charset=utf-8
      Content-Length: 1649
      Vary: Accept-Encoding
      X-Request-Id: 5b69acc5-f2eb-4dcd-9cb4-d92e36bf4751
      Link: <https://api.mailchimp.com/schema/3.0/FileManager/Folders/Collection.json>; rel="describedBy"
      Date: Wed, 16 Sep 2015 14:26:21 GMT
      Connection: keep-alive
      
      
      {
        "folders": [
          {
            "id": 861,
            "name": "Freddie's Best Jokes",
            "file_count": 1,
            "created_at": "2015-06-30T21:12:15+00:00",
            "created_by": "Freddie",
            "_links": [
              {
                "rel": "self",
                "href": "https://usX.api.mailchimp.com/3.0/file-manager/folders/861",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/FileManager/Folders/Instance.json"
              },
              {
                "rel": "update",
                "href": "https://usX.api.mailchimp.com/3.0/file-manager/folders/861",
                "method": "PATCH",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/FileManager/Folders/Instance.json"
              },
              {
                "rel": "delete",
                "href": "https://usX.api.mailchimp.com/3.0/file-manager/folders/861",
                "method": "DELETE",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/FileManager/Folders/Instance.json"
              },
              {
                "rel": "parent",
                "href": "https://usX.api.mailchimp.com/3.0/file-manager/folders/",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/FileManager/Folders/Collection.json",
                "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/FileManager/Folders.json"
              }
            ]
          }
        ],
        "total_items": 1,
        "_links": [
          {
            "rel": "parent",
            "href": "https://usX.api.mailchimp.com/3.0/",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Root.json"
          },
          {
            "rel": "self",
            "href": "https://usX.api.mailchimp.com/3.0/file-manager/folders",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/FileManager/Folders/Collection.json",
            "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/FileManager/Folders.json"
          },
          {
            "rel": "create",
            "href": "https://usX.api.mailchimp.com/3.0/file-manager/folders",
            "method": "POST",
            "schema": "https://api.mailchimp.com/schema/3.0/FileManager/Folders/Instance.json"
          }
        ]
      }
                                      

      Error response

      type Type: String Title: Problem Type Read only: false An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
      title Type: String Title: Error Title Read only: false 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.
      status Type: Integer Title: HTTP Status Code Read only: false The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
      detail Type: String Title: Error Message Read only: false A human-readable explanation specific to this occurrence of the problem. Learn more about errors.
      instance Type: String Title: Instance ID Read only: false A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.

      Get information about a specific folder

      GET /file-manager/folders/{folder_id}

      Get information about a specific folder in the File Manager.

      Path parameters

      folder_id The unique id for the File Manager folder.

      Query string parameters

      fields Type: Array Title: Fields Read only: false A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
      exclude_fields Type: Array Title: Exclude Fields Read only: false A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

      Response body parameters

      id Type: Integer Title: Folder ID Read only: true The unique id for the folder.
      name Type: String Title: Folder Name Read only: false The name of the folder.
      file_count Type: Integer Title: File Count Read only: true The number of files in the folder.
      created_at Type: String Title: Created Date Read only: true The date and time a file was added to the File Manager.
      created_by Type: String Title: Created By Read only: true The username of the profile that created the folder.
      _links Type: Array Title: Links Read only: true A list of link types and descriptions for the API schema documents.
      Show properties
      rel Type: String Title: Rel Read only: true As with an HTML ‘rel’ attribute, this describes the type of link.
      href Type: String Title: Href Read only: true This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
      method Type: String Title: Method Read only: true The HTTP method that should be used when accessing the URL defined in ‘href’.
      Possible Values:
      • GET
      • POST
      • PUT
      • PATCH
      • DELETE
      • OPTIONS
      • HEAD
      targetSchema Type: String Title: Target Schema Read only: true For GETs, this is a URL representing the schema that the response should conform to.
      schema Type: String Title: Schema Read only: true For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.

      Example request

      
      curl --request GET \
      --url 'https://usX.api.mailchimp.com/3.0/file-manager/folders/861' \
      --user 'anystring:apikey' \
      --include
                                      

      Example response

      
      HTTP/1.1 200 OK
      Server: nginx
      Content-Type: application/json; charset=utf-8
      Content-Length: 1000
      Vary: Accept-Encoding
      X-Request-Id: c140ab76-30cc-46b6-af82-bfde10ef83ad
      Link: <https://api.mailchimp.com/schema/3.0/FileManager/Folders/Instance.json>; rel="describedBy"
      Date: Wed, 16 Sep 2015 14:30:07 GMT
      Connection: keep-alive
      
      
      {
        "id": 861,
        "name": "Freddie's Best Jokes",
        "file_count": 1,
        "created_at": "2015-06-30T21:12:15+00:00",
        "created_by": "Freddie",
        "_links": [
          {
            "rel": "self",
            "href": "https://usX.api.mailchimp.com/3.0/file-manager/folders/861",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/FileManager/Folders/Instance.json"
          },
          {
            "rel": "update",
            "href": "https://usX.api.mailchimp.com/3.0/file-manager/folders/861",
            "method": "PATCH",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/FileManager/Folders/Instance.json"
          },
          {
            "rel": "delete",
            "href": "https://usX.api.mailchimp.com/3.0/file-manager/folders/861",
            "method": "DELETE",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/FileManager/Folders/Instance.json"
          },
          {
            "rel": "parent",
            "href": "https://usX.api.mailchimp.com/3.0/file-manager/folders/",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/FileManager/Folders/Collection.json",
            "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/FileManager/Folders.json"
          }
        ]
      }
                                      

      Error response

      type Type: String Title: Problem Type Read only: false An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
      title Type: String Title: Error Title Read only: false 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.
      status Type: Integer Title: HTTP Status Code Read only: false The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
      detail Type: String Title: Error Message Read only: false A human-readable explanation specific to this occurrence of the problem. Learn more about errors.
      instance Type: String Title: Instance ID Read only: false A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.
    • PATCH /file-manager/folders/{folder_id} Update a File Manager folder

      Update a File Manager folder

      PATCH /file-manager/folders/{folder_id}

      Update a specific File Manager folder.

      Path parameters

      folder_id The unique id for the File Manager folder.

      Request body parameters

      name Type: String Title: Folder Name Read only: false The name of the folder.

      Response body parameters

      id Type: Integer Title: Folder ID Read only: true The unique id for the folder.
      name Type: String Title: Folder Name Read only: false The name of the folder.
      file_count Type: Integer Title: File Count Read only: true The number of files in the folder.
      created_at Type: String Title: Created Date Read only: true The date and time a file was added to the File Manager.
      created_by Type: String Title: Created By Read only: true The username of the profile that created the folder.
      _links Type: Array Title: Links Read only: true A list of link types and descriptions for the API schema documents.
      Show properties
      rel Type: String Title: Rel Read only: true As with an HTML ‘rel’ attribute, this describes the type of link.
      href Type: String Title: Href Read only: true This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
      method Type: String Title: Method Read only: true The HTTP method that should be used when accessing the URL defined in ‘href’.
      Possible Values:
      • GET
      • POST
      • PUT
      • PATCH
      • DELETE
      • OPTIONS
      • HEAD
      targetSchema Type: String Title: Target Schema Read only: true For GETs, this is a URL representing the schema that the response should conform to.
      schema Type: String Title: Schema Read only: true For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.

      Example request

      
      curl --request PATCH \
      --url 'https://usX.api.mailchimp.com/3.0/file-manager/folders/861' \
      --user 'anystring:apikey' \
      --header 'content-type: application/json' \
      --data '{"name": "Changing the folder name"}' \
      --include
                                      

      Example response

      
      HTTP/1.1 200 OK
      Server: nginx
      Content-Type: application/json; charset=utf-8
      Content-Length: 1004
      Vary: Accept-Encoding
      X-Request-Id: fd178541-19cd-470a-ad73-551e4ffb5448
      Link: <https://api.mailchimp.com/schema/3.0/FileManager/Folders/Instance.json>; rel="describedBy"
      Date: Wed, 16 Sep 2015 14:31:44 GMT
      Connection: keep-alive
      
      
      {
        "id": 861,
        "name": "Changing the folder name",
        "file_count": 1,
        "created_at": "2015-06-30T21:12:15+00:00",
        "created_by": "Freddie",
        "_links": [
          {
            "rel": "self",
            "href": "https://usX.api.mailchimp.com/3.0/file-manager/folders/861",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/FileManager/Folders/Instance.json"
          },
          {
            "rel": "update",
            "href": "https://usX.api.mailchimp.com/3.0/file-manager/folders/861",
            "method": "PATCH",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/FileManager/Folders/Instance.json"
          },
          {
            "rel": "delete",
            "href": "https://usX.api.mailchimp.com/3.0/file-manager/folders/861",
            "method": "DELETE",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/FileManager/Folders/Instance.json"
          },
          {
            "rel": "parent",
            "href": "https://usX.api.mailchimp.com/3.0/file-manager/folders/",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/FileManager/Folders/Collection.json",
            "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/FileManager/Folders.json"
          }
        ]
      }
                                      

      Error response

      type Type: String Title: Problem Type Read only: false An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
      title Type: String Title: Error Title Read only: false 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.
      status Type: Integer Title: HTTP Status Code Read only: false The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
      detail Type: String Title: Error Message Read only: false A human-readable explanation specific to this occurrence of the problem. Learn more about errors.
      instance Type: String Title: Instance ID Read only: false A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.
    • DELETE /file-manager/folders/{folder_id} Remove a File Manager folder

      Remove a File Manager folder

      DELETE /file-manager/folders/{folder_id}

      Delete a specific folder in the File Manager.

      Example request

      
      curl --request DELETE \
      --url 'https://usX.api.mailchimp.com/3.0/file-manager/folders/861' \
      --user 'anystring:apikey' \
      --include
                                      

      Example response

      
      HTTP/1.1 204 No Content
      Server: nginx
      Content-Type: application/json; charset=utf-8
      Content-Length: 2
      X-Request-Id: 45133d49-6e79-4564-8c9b-eabc7467b237
      Date: Wed, 16 Sep 2015 14:33:51 GMT
      Connection: keep-alive
                                      

      Error response

      type Type: String Title: Problem Type Read only: false An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
      title Type: String Title: Error Title Read only: false 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.
      status Type: Integer Title: HTTP Status Code Read only: false The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
      detail Type: String Title: Error Message Read only: false A human-readable explanation specific to this occurrence of the problem. Learn more about errors.
      instance Type: String Title: Instance ID Read only: false A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.