Introduction
This API returns the “bounce” list – this is a list of non-delivered and returned email addresses generated by ISPs and other gateways. A reason is provided where possible, together with email and date. This is a very useful feature to help clean up email lists.
The CustomerGauge system will not retry sending to email addresses that are on this list.
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/bounce.json
US Production Server: https://api.us.customergauge.com/v4.1/lists/bounce.json
Australia Production Server: https://api.au.customergauge.com/v4.1/lists/bounce.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/bounce.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/bounce.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/bounce.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.edwards@yahoo.co.uk", "Type":"hard", "Reason":"554 delivery error: dd This user doesn't have a yahoo.co.uk account (edwards3@yahoo.co.uk) [-5] - mta1163.mail.ir2.yahoo.com " "Date":"2013-03-11 16:37:10", }, { "Email":"djavouboy@hotmail.com", "Type":"hard", "Reason":"550 Requested action not taken: mailbox unavailable ", "Date":"2013-03-11 16:28:10", }, { "Email":"mtxyz@optusnet.com.au", "Type":"hard", "Reason":"452 4.2.2 <mtoye@optusnet.com.au>... Mailbox full", "Date":"2013-03-10 13:21:10", } ], "Total_Records":3 }
Message reported on failed operation:
{ "Error": { "Message": "Record does not exist", "Code": 400401 } }
Not the API you're looking for?
APIs of the same family:
Or view: