Embedded Files
API Documentation V2
SnoozedSubscribers collection allows snoozing subscribers using HTTP POST method. Snoozing subscriber effectively suspends his subscription for a specified period of time. During this period, subscriber will not receive any emails.
Snoozing a particular channel will not necessarily snooze the subscriber. It is possible to snooze a particular channel.
If subscriber is already snoozed, an appropriate error message will be returned.
Request data format
Request data format
Data element children:
* At least one of the following must be specified: Id, Email, Phone, CustomSubscriberId. We look first for Id, then Email, Phone and CustomSubscriberId. If more then one is specified we will check the first element with any value and ignore the others.
** Depending on which element(s) is provided channel will default to different values: Id - All, Email - Email; Phone - SmsMms; CustomSubscriberId - All.
Examples
Examples
Request:
POST https://api.esv2.com/v2/Api/SnoozedSubscribers HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: application/xml
Content-Length: 288
Host: api.esv2.com
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)
<ApiRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<ApiKey>test_api_key1</ApiKey>
<Data>
<Email>testsnoozed1@test123.com</Email>
<ListId>101</ListId>
<SnoozeWeeks>14</SnoozeWeeks>
</Data>
</ApiRequest>
Response:
HTTP/1.1 201 Created
Cache-Control: private
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:33:05 GMT
Content-Length: 0
Report abuse