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.


Resource Information

Response formatsJSON (default), XML
HTTP methodGET
Response familylists
Header
Authorization: api_key XXXXX


Resource URL

Europe Production Server:

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


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


Example Result


Message reported on successful operation:




1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26




{
  "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:




1




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