Connected Sites

Manage sites you’ve connected to your MailChimp account.

Available methods

    • POST /connected-sites Create a new connected site

      Create a new connected site

      POST /connected-sites

      Create a new MailChimp connected site.

      Request body parameters

      foreign_id Type: String Title: Connected Site Foreign ID Read only: false The unique identifier for the site.
      domain Type: String Title: Domain Read only: false The connected site domain.

      Response body parameters

      foreign_id Type: String Title: Connected Site Foreign ID Read only: false The unique identifier for the site.
      store_id Type: String Title: Store ID Read only: false The unique identifier for the ecommerce store that’s associated with the connected site (if any). The store_id for a specific connected site can’t change.
      platform Type: String Title: Connected Site Platform Read only: false The platform of the connected site.
      domain Type: String Title: Domain Read only: false The connected site domain.
      site_script Type: Object Title: Script Read only: false The script used to connect your site with MailChimp.
      Show properties
      url Type: String Title: Script URL Read only: false The URL used for any integrations that offer built-in support for connected sites.
      fragment Type: String Title: Script Fragment Read only: false A pre-built script that you can copy-and-paste into your site to integrate it with MailChimp.
      created_at Type: String Title: Creation Time Read only: false The date and time the connected site was created.
      updated_at Type: String Title: Update Time Read only: false The date and time the connected site was last updated.
      _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.

      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 /connected-sites Get all connected sites
      GET /connected-sites/{connected_site_id} Get information about a specific connected site

      Get all connected sites

      GET /connected-sites

      Get all connected sites in an account.

      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.

      Response body parameters

      sites Type: Array Title: Connected Sites Read only: false An array of objects, each representing a connected site.
      Show properties
      foreign_id Type: String Title: Connected Site Foreign ID Read only: false The unique identifier for the site.
      store_id Type: String Title: Store ID Read only: false The unique identifier for the ecommerce store that’s associated with the connected site (if any). The store_id for a specific connected site can’t change.
      platform Type: String Title: Connected Site Platform Read only: false The platform of the connected site.
      domain Type: String Title: Domain Read only: false The connected site domain.
      site_script Type: Object Title: Script Read only: false The script used to connect your site with MailChimp.
      Show properties
      url Type: String Title: Script URL Read only: false The URL used for any integrations that offer built-in support for connected sites.
      fragment Type: String Title: Script Fragment Read only: false A pre-built script that you can copy-and-paste into your site to integrate it with MailChimp.
      created_at Type: String Title: Creation Time Read only: false The date and time the connected site was created.
      updated_at Type: String Title: Update Time Read only: false The date and time the connected site was last updated.
      _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.

      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 connected site

      GET /connected-sites/{connected_site_id}

      Get information about a specific connected site.

      Path parameters

      connected_site_id The unique identifier for the site.

      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

      foreign_id Type: String Title: Connected Site Foreign ID Read only: false The unique identifier for the site.
      store_id Type: String Title: Store ID Read only: false The unique identifier for the ecommerce store that’s associated with the connected site (if any). The store_id for a specific connected site can’t change.
      platform Type: String Title: Connected Site Platform Read only: false The platform of the connected site.
      domain Type: String Title: Domain Read only: false The connected site domain.
      site_script Type: Object Title: Script Read only: false The script used to connect your site with MailChimp.
      Show properties
      url Type: String Title: Script URL Read only: false The URL used for any integrations that offer built-in support for connected sites.
      fragment Type: String Title: Script Fragment Read only: false A pre-built script that you can copy-and-paste into your site to integrate it with MailChimp.
      created_at Type: String Title: Creation Time Read only: false The date and time the connected site was created.
      updated_at Type: String Title: Update Time Read only: false The date and time the connected site was last updated.
      _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.

      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 a connected site

      DELETE /connected-sites/{connected_site_id}

      Remove a connected site from your MailChimp account.

      Path parameters

      connected_site_id The unique identifier for the site.

      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.
    • Verify script installation for a connected site

      POST /connected-sites/{connected_site_id}/actions/verify-script-installation

      Verify that the connected sites script has been installed, either via the script URL or fragment.

      Path parameters

      connected_site_id The unique identifier for the site.

      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.