Introduction

This API returns the “unsubscribe” list – this is a “stop list” generated by end customers clicking on the the “Unsubscribe” link in the email.

It blocks the future sending of emails to that address. You can also add emails to this list using the POST Unsubscribe method.


Good to know

API response format:

Our APIs return data in either JSON or XML format (depending on request by .json or .xml).


About this API

Resource Information

Response formats
JSON (default), XML
HTTP method
GET
Response family
Lists
Header
Authorization: api_key XXXXX


Resource URL

Europe Production Server: https://api.eu.customergauge.com/v4.1/lists/unsubscribe.json

US Production Server: https://api.us.customergauge.com/v4.1/lists/unsubscribe.json

Australia Production Server: https://api.au.customergauge.com/v4.1/lists/unsubscribe.json


How to call

Parameters

date_range_from 
optional
Filter the data from date
Example Values: 2012-09-01
date_range_to
optional
Filter the data to date
Example Values: 2012-10-01
start
optional
default: 0
Example Values: 10
limit
optional
default: 1000
Example Values: 200. Maximum is 1000


Example Requests

GET (json)
https://api.eu.customergauge.com/v4.1/lists/unsubscribe.json?date_range_from=2012-11-10&date_range_to=2014-10-19&limit=100&start=100


GET (xml)
https://api.eu.customergauge.com/v4.1/lists/unsubscribe.xml?date_range_from=2012-11-10&date_range_to=2014-10-19&limit=100&start=100


To call this API through cURL:

curl -H "Authorization: api_key XXXXX" -X GET https://api.eu.customergauge.com/v4.1/lists/unsubscribe.xml?date_range_from=2012-11-10&date_range_to=2014-10-19&limit=100&start=100


Example Result

Message reported on successful operation:

{
  "Data":
    [
       {
         "Email":"ingrid.wilkes@directness.net",
         "Date":"2011-05-11 16:37:10",
         "User":""
       },
       {
          "Email":"ingrid.wilkes@directness.net",
          "Date":"2011-05-11 16:37:14",
          "User":""
        },
        {
           "Email":"nuria.moreu@directness.net",
           "Date":"2012-09-17 15:06:15",
           "User":""
        },
        {
           "Email":"test@test.com",
           "Date":"2012-10-12 17:59:39",
           "User":""
        }
     ],
  "Total_Records":4
}


Message reported on failed operation:

{
  "Error": {
    "Message": "Record does not exist",
    "Code": 400401
  }
}


Not the API you're looking for?

Related APIs:


APIs of the same family:


Or view: