Abuse Reports

Manage abuse complaints for a specific list. An abuse complaint occurs when your recipient reports an email as spam in their mail program.

Available methods

    • GET /lists/{list_id}/abuse-reports Get information about abuse reports
      GET /lists/{list_id}/abuse-reports/{report_id} Get details about a specific abuse report

      Get information about abuse reports

      GET /lists/{list_id}/abuse-reports

      Get all abuse reports for a specific list.

      Path parameters

      list_id The unique id for the list.

      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. Maximum value is 1000
      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

      abuse_reports Type: Array Title: Abuse Reports Read only: false An array of objects, each representing an abuse report resource.
      Show properties
      id Type: Integer Title: Abuse Report ID Read only: true The id for the abuse report
      campaign_id Type: String Title: Campaign ID Read only: true The campaign id for the abuse report
      list_id Type: String Title: List ID Read only: true The list id for the abuse report.
      email_id Type: String Title: Email Hash Read only: true The MD5 hash of the lowercase version of the list member’s email address.
      email_address Type: String Title: Email Address Read only: true Email address for a subscriber.
      merge_fields Type: Object Title: Member Merge Var Read only: true An individual merge var and value for a member.
      vip Type: Boolean Title: VIP Read only: true VIP status for subscriber.
      date Type: String Title: Date Read only: true Date for the abuse report
      _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.
      list_id Type: String Title: List ID Read only: false The list id for the abuse report.
      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/lists/1a2df69511/abuse-reports' \
--user 'anystring:apikey' \
--include

      Example response

      
HTTP/1.1 200 OK
Server: nginx
Content-Type: application/json; charset=utf-8
Content-Length: 505
Vary: Accept-Encoding
X-Request-Id: a2690117-add6-4650-8d82-7bb99f1851af
Link: <https://api.mailchimp.com/schema/3.0/Lists/Abuse/Collection.json>; rel="describedBy"
Date: Wed, 16 Sep 2015 15:37:55 GMT
Connection: keep-alive


{
  "abuse_reports": [
    {
      "id": 42,
      "campaign_id": "839488a60b",
      "list_id": "1a2df69511",
      "email_id": "62eeb292278cc15f5817cb78f7790b08",
      "email_address": "urist.mcvankab@freddiesjokes.com",
      "date": "string"
    }
  ],
  "list_id": "1a2df69511",
  "total_items": 1,
  "_links": [
    {
      "rel": "self",
      "href": "https://usX.api.mailchimp.com/3.0/lists/1a2df69511/abuse-reports",
      "method": "GET",
      "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Abuse/Collection.json",
      "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists/Abuse.json"
    },
    {
      "rel": "parent",
      "href": "https://usX.api.mailchimp.com/3.0/lists/1a2df69511",
      "method": "GET",
      "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/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 details about a specific abuse report

      GET /lists/{list_id}/abuse-reports/{report_id}

      Get details about a specific abuse report.

      Path parameters

      list_id The unique id for the list.
      report_id The id for the abuse report.

      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. Maximum value is 1000
      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

      id Type: Integer Title: Abuse Report ID Read only: true The id for the abuse report
      campaign_id Type: String Title: Campaign ID Read only: true The campaign id for the abuse report
      list_id Type: String Title: List ID Read only: true The list id for the abuse report.
      email_id Type: String Title: Email Hash Read only: true The MD5 hash of the lowercase version of the list member’s email address.
      email_address Type: String Title: Email Address Read only: true Email address for a subscriber.
      merge_fields Type: Object Title: Member Merge Var Read only: true An individual merge var and value for a member.
      vip Type: Boolean Title: VIP Read only: true VIP status for subscriber.
      date Type: String Title: Date Read only: true Date for the abuse report
      _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/lists/1a2df69511/abuse-reports/42' \
--user 'anystring:apikey' \
--include

      Example response

      
HTTP/1.1 200 OK
Server: nginx
Content-Type: application/json; charset=utf-8
Content-Length: 505
Vary: Accept-Encoding
X-Request-Id: a2690117-add6-4650-8d82-7bb99f1851ag
Link: <https://api.mailchimp.com/schema/3.0/Lists/Abuse/Instance.json>; rel="describedBy"
Date: Wed, 16 Sep 2015 15:38:00 GMT
Connection: keep-alive


{
  "id": 42,
  "campaign_id": "839488a60b",
  "list_id": "1a2df69511",
  "email_id": "62eeb292278cc15f5817cb78f7790b08",
  "email_address": "urist.mcvankab@freddiesjokes.com",
  "date": "2015-07-15T19:19:31+00:00",
  "links": [
    {
      "rel": "self",
      "href": "https://usX.api.mailchimp.com/3.0/lists/1a2df69511/abuse-reports/42",
      "method": "GET",
      "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Abuse/Instance.json"
    },
    {
      "rel": "parent",
      "href": "https://usX.api.mailchimp.com/3.0/lists/1a2df69511/abuse-reports",
      "method": "GET",
      "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Abuse/Collection.json",
      "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists/Abuse.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.