Skip to content

Pause or resume newsletter

All newsletters with status “InProgress” can be paused. Only “Paused” newsletters can be resumed.

Request data format

Element/attributeTypeNotes
ApiKeystring Client API key, required for authentication. Required.
ActionstringWhat kind of modification should be made. Required. Valid values are:
PauseMessage
ResumeMessage

Response

Regardless of the status change, data element always returns 0.

Response Data element:

Element/attributeTypeNotes
(Data element content)intAlways returns 0

Examples

Resuming paused newsletter

Request:

PUT https://api.esv2.com/v2/Api/SmsMmsNewsletters/1000 HTTP/1.1 
Accept-Encoding: gzip,deflate 
Content-Type: text/xml;charset=UTF-8
Host: api.esv2.com

<ApiRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">
   <ApiKey>2OAEcpz0Rwv3Mhc9nTQK</ApiKey>
   <Action>ResumeMessage</Action>
</ApiRequest>

Response:

HTTP/1.1 201 Created 
Cache-Control: private 
Content-Type: text/xml; charset=utf-8 
Server: Microsoft-IIS/7.5 
X-AspNetMvc-Version: 3.0 
X-AspNet-Version: 4.0.30319 
X-Powered-By: ASP.NET 
Date: Tue, 27 Mar 2012 13:28:01 GMT 
Content-Length: 149  

<ApiResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <Data>0</Data>
</ApiResponse>
Privacy policy