Start suppression list export

Suppression list exports collection allows scheduling (asynchronous) exports of suppression lists. Data is exported in CSV format.

Export status may be then checked by sending a GET request and when the export is ready, the request will return an URL to file available for download.

Request data format

Data part of request for scheduling an export.

Data element children:

Element/attribute	Type	Notes
ListId	integer	ID of subscriber suppression list to export.
EntryType	string	The type of column to be exported. There are 6 options for selecting the type of exported column. Default email Email Md5 Sha256 Domain For customers with SMS/MMS integration enabled there are export type available Phone DialingPrefix

Response

Method returns ID of scheduled export. ID can be used to get export status using GET method.

Response Data element:

Element/attribute	Type	Notes
(Data element content)	int	ID of scheduled export.

Examples

Simple suppression list export

Request:

POST https://api.esv2.com/v2/Api/SuppressionListExports HTTP/1.1 
Accept-Encoding: gzip,deflate 
Content-Type: application/xml 
User-Agent: Jakarta Commons-HttpClient/3.1 
Host: api.esv2.com 
Content-Length: 411 

<ApiRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <ApiKey>test_api_key1</ApiKey>
  <Data>
    <ListId>11</ListId>
    <EntryType>Domain</EntryType>
  </Data>
</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: Mon, 25 Nov 2013 16:40:14 GMT 
Content-Length: 147  

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