Przejdź do treści

Get unconfirmed subscribers

UnconfirmedSubscribers collection allows retrieving a list of subscribers that did not confirm their subscription. The list can be filtered by subscriber’s list ID and date range.

Request data format

Request URL parameters:

ParameterTypeNotes
apiKeystringYour API key, required for authentication. Required.
listIdsint (CSV)List identifiers. Optional. If specified, only unconfirmed subscribers from given lists will be returned. If not specified, unconfirmed subscribers from all lists will be returned. To specify multiple list IDs, use comma separated format, e.g.: 12,34,56,789
startDatedateStart date. Optional. If specified, subscribers that subscribed after specified date but did not confirmed their subscription will be returned. May be used together with endDate to specify a period of time. YYYY-MM-DD format.
endDatedateSee startDate.

Note: Make notice that only apiKey parameter is required. If you omit other parameters, you will get a list of all unconfirmed subscribers, from any list, with any subscription date.

Example URLs:

https://api.esv2.com/v2/Api/UnconfirmedSubscribers?apiKey=YOUR_API_KEY_HERE 

https://api.esv2.com/v2/Api/UnconfirmedSubscribers?apiKey=YOUR_API_KEY_HERE&listIds=1,3,16 

https://api.esv2.com/v2/Api/UnconfirmedSubscribers?apiKey=YOUR_API_KEY_HERE&startDate=2014-03-01&endDate=2014-03-10

Response

Response Data element:

Element/attributeTypeNotes
UnconfirmedSubscribersListarray[complex]Array of UnconfirmedSubscriber elements.

UnconfirmedSubscriber element children:

Element/attributeTypeNotes
EmailstringEmail of unconfirmed subscriber.
ListIdintIdentifier of list that subscriber did not confirm his subscription.
SubscribedOndateTimeDate and time when subscribed.

Examples

Request:

GET https://api.esv2.com/v2/Api/UnconfirmedSubscribers?apiKey=test_api_key1 HTTP/1.1
Accept-Encoding: gzip,deflate
Host: api.esv2.com
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: text/xml; charset=utf-8
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 5.1
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Wed, 05 Mar 2014 12:16:49 GMT
Content-Length: 591

<ApiResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
 <Data>
   <UnconfirmedSubscribers>
     <UnconfirmedSubscriber>
       <Email>test1@test123.com</Email>
       <ListId>1222</ListId>
       <SubscribedOn>2016-03-22T13:06:03</SubscribedOn>
     </UnconfirmedSubscriber>
     <UnconfirmedSubscriber>
       <Email>test2@test123.com</Email>
       <ListId>1222</ListId>
       <SubscribedOn>2016-03-22T13:06:31</SubscribedOn>
     </UnconfirmedSubscriber>
     <UnconfirmedSubscriber>
       <Email>test3@test123.com</Email>
       <ListId>1222</ListId>
       <SubscribedOn>2016-04-21T05:39:45</SubscribedOn>
     </UnconfirmedSubscriber>
     <UnconfirmedSubscriber>
       <Email>test4@test123.com</Email>
       <ListId>1222</ListId>
       <SubscribedOn>2016-03-22T13:28:59</SubscribedOn>
     </UnconfirmedSubscriber>
   </UnconfirmedSubscribers>
 </Data>
</ApiResponse>
Polityka prywatności