{"id":3689,"date":"2023-08-31T06:08:03","date_gmt":"2023-08-31T05:08:03","guid":{"rendered":"https:\/\/help.expertsender.com\/?post_type=es&p=3689"},"modified":"2024-04-25T07:57:06","modified_gmt":"2024-04-25T06:57:06","slug":"get-rejected-subscribers","status":"publish","type":"es","link":"https:\/\/help.expertsender.com\/pl\/emp\/api\/methods\/imports\/get-rejected-subscribers\/","title":{"rendered":"Get rejected subscribers"},"content":{"rendered":"\n

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.<\/p>\n\n\n\n

<\/a><\/a>Request data format<\/strong><\/h3>\n\n\n\n

Request URL parameters:<\/p>\n\n\n\n

Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
apiKey<\/td>string<\/td>Your API key, required for authentication. Required.<\/td><\/tr>
id<\/td>integer<\/td>ID of import to list task. ID can be obtained while\u00a0scheduling the task<\/a>.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Example URL:<\/p>\n\n\n\n

<\/path><\/path><\/svg><\/span>
https:\/\/api.esv2.com\/v2\/Api\/ImportToListRejected?apiKey=YOUR_API_KEY_HERE&id=123<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Response<\/strong><\/h3>\n\n\n\n
The response from this method is always data in CSV format, rather than XML, because the amount of data returned can be substantial.<\/p>\n\n\n\n
CSV response minimizes overheads and allows for seamless integration with third party code\/systems.<\/p>\n\n\n\n
Response content type is “text\/csv”. Returned data contains a header with column names in the first row.<\/p>\n\n\n\n
CSV output is formatted using following settings:<\/p>\n\n\n\n
    \n
  • Field separator: comma (,)<\/li>\n\n\n\n
  • Quoting character: (“)<\/li>\n\n\n\n
  • Escape character: (“)<\/li>\n\n\n\n
  • Encoding: UTF-8<\/li>\n<\/ul>\n\n\n\n
    CSV response columns:<\/p>\n\n\n\n
    Name<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
    Value<\/td>string<\/td>Value (e.g. email address, phone number) that was rejected.<\/td><\/tr>
    Problem<\/td>string<\/td>Reason why email was rejected. See below for all possible reasons.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
    Problem types (one of those will be in Problem column in CSV):<\/p>\n\n\n\n
    Name<\/th>Description<\/th><\/tr><\/thead>
    Conflicting Custom Subscriber ID<\/td>Custom Subscriber ID conflicted with existing subscribers.<\/td><\/tr>
    Conflicting Email<\/td>email address conflicted with existing subscribers.<\/td><\/tr>
    Conflicting Phone<\/td>phone number conflicted with existing subscribers.<\/td><\/tr>
    Country\/Region blacklisted<\/td>value was rejected because its dialing prefix was present on a local blacklist.<\/td><\/tr>
    Domain blacklisted<\/td>value was rejected because its domain is present on blacklist.<\/td><\/tr>
    Domain rejected<\/td>value was rejected because its domain is present on global blacklist.<\/td><\/tr>
    Duplicated Custom Subscriber ID<\/td>Custom Subscriber ID was duplicated in the import.<\/td><\/tr>
    Duplicated Email<\/td>email was duplicated in the import.<\/td><\/tr>
    Duplicated Phone<\/td>phone number was duplicated in the import.<\/td><\/tr>
    Email blacklisted<\/td>email was rejected because it was present on a local blacklist.<\/td><\/tr>
    Email rejected<\/td>value was rejected using internal rule. It usually means that subscriber either does not exist or issued spam complaints.<\/td><\/tr>
    Empty Custom Subscriber ID<\/td>Custom Subscriber ID was empty<\/td><\/tr>
    Empty email<\/td>email address was empty<\/td><\/tr>
    Empty phone number<\/td>phone number was empty<\/td><\/tr>
    Entries skipped because of selected import type<\/td>value was skipped because it did not fit the import criteria.<\/td><\/tr>
    Invalid<\/td>string is not valid (wrong formatting etc).<\/td><\/tr>
    Invalid Custom Subscriber ID<\/td>string is not a valid Custom Subscriber ID<\/td><\/tr>
    Invalid email address<\/td>string is not a valid email address<\/td><\/tr>
    Invalid phone number<\/td>string is not a valid phone number<\/td><\/tr>
    Opted out<\/td>subscriber previously unsubscribed from the list (only during imports with AllowImportingUnsubscribed option set to false).<\/td><\/tr>
    Parsing error<\/td>line of imported file is corrupted and could not be parsed.<\/td><\/tr>
    Phone blacklisted<\/td>phone was rejected because it was present on a local blacklist<\/td><\/tr>
    Phone rejected<\/td>phone was rejected because it was present on a global blacklist<\/td><\/tr>
    Skipped due to no value of a required custom field<\/td>self-explanatory.<\/td><\/tr>
    Skipped Email<\/td>value was skipped because it was not found on the list (in ReplaceOnly and UpdateOnly mode) or because it it already existed on a list (in AddOnly mode).<\/td><\/tr>
    Skipped Phone<\/td>value was skipped because it was not found on the list (in ReplaceOnly and UpdateOnly mode) or because it it already existed on a list (in AddOnly mode)<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
    Examples<\/strong><\/h3>\n\n\n\n
    Request:<\/p>\n\n\n\n
    <\/path><\/path><\/svg><\/span>
    GET http:\/\/api.esv2.com\/v2\/Api\/ImportToListRejected?apiKey=test_api_key1&id=287 HTTP\/1.1<\/span><\/span>\nAccept-Encoding: gzip,deflate<\/span><\/span>\nHost: api.esv2.com<\/span><\/span>\nConnection: Keep-Alive<\/span><\/span>\nUser-Agent: Apache-HttpClient\/4.1.1 (java 1.5)<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
    OK response:<\/p>\n\n\n\n
    <\/path><\/path><\/svg><\/span>
    HTTP\/1.1 200 OK<\/span><\/span>\nCache-Control: private<\/span><\/span>\nContent-Type: text\/csv; charset=utf-8<\/span><\/span>\nServer: Microsoft-IIS\/7.5<\/span><\/span>\nX-AspNetMvc-Version: 5.1<\/span><\/span>\nX-AspNet-Version: 4.0.30319<\/span><\/span>\nSet-Cookie: TEMP_DATA=27aa335a-4ef6-49c0-af32-d143691fa14b; path=\/<\/span><\/span>\nX-Powered-By: ASP.NET<\/span><\/span>\nDate: Tue, 24 Jun 2014 10:47:38 GMT<\/span><\/span>\nContent-Length: 31336<\/span><\/span>\n<\/span>\nValue,Problem<\/span><\/span>\ninvalid1.@domain.com,Invalid email address<\/span><\/span>\n123invalid678,Invalid phone number<\/span><\/span>\nblacklisted@domain.com,Email blacklisted<\/span><\/span>\nusername@blacklisted.com,Domain blacklisted<\/span><\/span>\n48506089829,Skipped Phone<\/span><\/span>\n<\/span>\n...<\/span><\/span><\/code><\/pre><\/div>\n","protected":false},"author":5,"featured_media":0,"parent":3682,"menu_order":287,"template":"","format":"standard","emp-category":[],"class_list":["post-3689","es","type-es","status-publish","format-standard","hentry"],"acf":[],"_links":{"self":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3689","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es"}],"about":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/types\/es"}],"author":[{"embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/users\/5"}],"version-history":[{"count":4,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3689\/revisions"}],"predecessor-version":[{"id":10444,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3689\/revisions\/10444"}],"up":[{"embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3682"}],"wp:attachment":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/media?parent=3689"}],"wp:term":[{"taxonomy":"emp-category","embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/emp-category?post=3689"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}