API Documentation V2
ImportToListRejected collection allows retrieving a list of subscribers that were rejected during an import for various reasons. Executing a GET request on this collection will return the data in CSV format. This is the same information that can be retrieved manually through Reports->Imports page in ExpertSender Panel application.
Request URL parameters:
Example URL:
https://api.esv2.com/v2/Api/ImportToListRejected?apiKey=YOUR_API_KEY_HERE&id=123
The response from this method is always data in CSV format, rather than XML, because the amount of data returned can be substantial.
CSV response minimizes overheads and allows for seamless integration with third party code/systems.
Response content type is "text/csv". Returned data contains a header with column names in the first row.
CSV output is formatted using following settings:
Field separator: comma (,)
Quoting character: (")
Escape character: (")
Encoding: UTF-8
CSV response columns:
Problem types (one of those will be in Problem column in CSV):
Request:
GET http://api.esv2.com/v2/Api/ImportToListRejected?apiKey=test_api_key1&id=287 HTTP/1.1
Accept-Encoding: gzip,deflate
Host: api.esv2.com
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)
OK response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: text/csv; charset=utf-8
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 5.1
X-AspNet-Version: 4.0.30319
Set-Cookie: TEMP_DATA=27aa335a-4ef6-49c0-af32-d143691fa14b; path=/
X-Powered-By: ASP.NET
Date: Tue, 24 Jun 2014 10:47:38 GMT
Content-Length: 31336
Value,Problem
invalid1.@domain.com,Invalid email address
123invalid678,Invalid phone number
blacklisted@domain.com,Email blacklisted
username@blacklisted.com,Domain blacklisted
48506089829,Skipped Phone
...