{"id":3631,"date":"2023-08-30T06:54:42","date_gmt":"2023-08-30T05:54:42","guid":{"rendered":"https:\/\/help.expertsender.com\/?post_type=es&p=3631"},"modified":"2024-06-25T12:45:39","modified_gmt":"2024-06-25T11:45:39","slug":"get-snoozed-subscribers","status":"publish","type":"es","link":"https:\/\/help.expertsender.com\/pl\/emp\/api\/methods\/subscribers\/get-snoozed-subscribers\/","title":{"rendered":"Get snoozed subscribers"},"content":{"rendered":"\n

SnoozedSubscribers collection allows retrieving a list of subscribers that have suspended (snoozed) their subscription. The list can be filtered by subscriber’s list ID and date range.<\/p>\n\n\n\n

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

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

Parameter<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
apiKey<\/td>string<\/td>Your API key, required for authentication. Required.<\/td><\/tr>
listIds<\/td>int (CSV)<\/td>List identifiers. Optional. If specified, only snoozed subscribers from given lists will be returned. If not specified, snoozed subscribers from all lists will be returned. To specify multiple list IDs, use comma separated format, e.g.: 12,34,56,789<\/td><\/tr>
startDate<\/td>date<\/td>Start date. Optional. If specified, subscribers whose subscription suspension expires prior to this date will not be returned. May be used together with endDate to specify a period of time. YYYY-MM-DD format.<\/td><\/tr>
endDate<\/td>date<\/td>See startDate.<\/td><\/tr>
channel<\/td>string<\/td>Limits returned data to selected channel. Optional. Defaults to Email. Valid values:
All
Email
SmsMms<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Note: Make notice that only apiKey parameter is required. If you omit other parameters, you will get a list of all snoozed subscribers, from any list, with any suspension expiration date.<\/p>\n\n\n\n

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

<\/path><\/path><\/svg><\/span>
https:\/\/api.esv2.com\/v2\/Api\/SnoozedSubscribers?apiKey=YOUR_API_KEY_HERE <\/span><\/span>\n<\/span>\nhttps:\/\/api.esv2.com\/v2\/Api\/SnoozedSubscribers?apiKey=YOUR_API_KEY_HERE&listIds=1,3,16 <\/span><\/span>\n<\/span>\nhttps:\/\/api.esv2.com\/v2\/Api\/SnoozedSubscribers?apiKey=YOUR_API_KEY_HERE&startDate=2014-03-01&endDate=2014-03-10<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Response<\/strong><\/h3>\n\n\n\n
Response Data element:<\/p>\n\n\n\n
Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
SnoozedSubscribersList<\/td>array[complex]<\/td>Array of SnoozedSubscriber elements.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
SnoozedSubscriber element children:<\/p>\n\n\n\n
Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
Email<\/td>string<\/td>Email of snoozed subscriber.<\/td><\/tr>
Phone<\/td>string<\/td>Phone number of snoozed subscriber.<\/td><\/tr>
ListId<\/td>int<\/td>Identifier of list that subscriber snoozed his subscription from.<\/td><\/tr>
SnoozedUntil<\/td>dateTime<\/td>Date and time when subscription suspension expires.<\/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 https:\/\/api.esv2.com\/v2\/Api\/SnoozedSubscribers?apiKey=test_api_key1&channel=All HTTP\/1.1<\/span><\/span>\nAccept-Encoding: gzip,deflate<\/span><\/span>\nHost: api.esv2.com<\/span><\/span>\nUser-Agent: Apache-HttpClient\/4.1.1 (java 1.5)<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
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\/xml; 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>\nX-Powered-By: ASP.NET<\/span><\/span>\nDate: Wed, 05 Mar 2014 12:16:49 GMT<\/span><\/span>\nContent-Length: 591<\/span><\/span>\n<\/span>\n<<\/span>ApiResponse<\/span> <\/span>xmlns<\/span>:<\/span>xsd<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema<\/span>"<\/span> <\/span>xmlns<\/span>:<\/span>xsi<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema-instance<\/span>"<\/span>><\/span><\/span>\n  <\/span><<\/span>Data<\/span>><\/span><\/span>\n    <\/span><<\/span>SnoozedSubscribers<\/span>><\/span><\/span>\n      <\/span><<\/span>SnoozedSubscriber<\/span>><\/span><\/span>\n        <\/span><<\/span>Email<\/span>><\/span>testsnoozed1@test123.com<\/span><\/<\/span>Email<\/span>><\/span><\/span>\n        <\/span><<\/span>ListId<\/span>><\/span>22<\/span><\/<\/span>ListId<\/span>><\/span><\/span>\n        <\/span><<\/span>SnoozedUntil<\/span>><\/span>2017-03-05T11:13:04Z<\/span><\/<\/span>SnoozedUntil<\/span>><\/span><\/span>\n      <\/span><\/<\/span>SnoozedSubscriber<\/span>><\/span><\/span>\n      <\/span><<\/span>SnoozedSubscriber<\/span>><\/span><\/span>\n        <\/span><<\/span>Email<\/span>><\/span>testsnoozed2@test123.com<\/span><\/<\/span>Email<\/span>><\/span><\/span>\n        <\/span><<\/span>ListId<\/span>><\/span>101<\/span><\/<\/span>ListId<\/span>><\/span><\/span>\n        <\/span><<\/span>SnoozedUntil<\/span>><\/span>2017-04-28T15:09:44Z<\/span><\/<\/span>SnoozedUntil<\/span>><\/span><\/span>\n      <\/span><\/<\/span>SnoozedSubscriber<\/span>><\/span><\/span>\n      <\/span><<\/span>SnoozedSubscriber<\/span>><\/span><\/span>\n        <\/span><<\/span>Phone<\/span>><\/span>48502123321<\/span><\/<\/span>Phone<\/span>><\/span><\/span>\n        <\/span><<\/span>ListId<\/span>><\/span>101<\/span><\/<\/span>ListId<\/span>><\/span><\/span>\n        <\/span><<\/span>SnoozedUntil<\/span>><\/span>2017-04-28T15:09:44Z<\/span><\/<\/span>SnoozedUntil<\/span>><\/span><\/span>\n      <\/span><\/<\/span>SnoozedSubscriber<\/span>><\/span><\/span>\n    <\/span><\/<\/span>SnoozedSubscribers<\/span>><\/span><\/span>\n  <\/span><\/<\/span>Data<\/span>><\/span><\/span>\n<\/<\/span>ApiResponse<\/span>><\/span><\/span><\/code><\/pre><\/div>\n","protected":false},"author":5,"featured_media":0,"parent":3621,"menu_order":310,"template":"","format":"standard","emp-category":[],"class_list":["post-3631","es","type-es","status-publish","format-standard","hentry"],"acf":[],"_links":{"self":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3631","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":3,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3631\/revisions"}],"predecessor-version":[{"id":11009,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3631\/revisions\/11009"}],"up":[{"embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3621"}],"wp:attachment":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/media?parent=3631"}],"wp:term":[{"taxonomy":"emp-category","embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/emp-category?post=3631"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}