Embedded Files
API Documentation V2
ImportToSuppressionListTasks collection allows scheduling (asynchronous) imports to suppression lists. Subscribers are imported from an external source, e.g. file stored on FTP server.
Currently, only one-time, immediately executed imports are supported.
Executing a GET request on ImportToSuppressionListTasks collection allows polling for scheduled import status (e.g. if it is still in progress or already finished).
Request data format
Request data format
Data part of request for scheduling a new import to suppression list.
Data element children:
Source element children:
Target element children:
ImportSetup element children:
Supported import modes:
Response
Response
Method returns ID of scheduled import. ID can be used to get import status using GET method.
Response Data element:
Examples
Examples
Scheduling a new subscribers suppression list import with default options
Request:
POST https://api.esv2.com/v2/Api/ImportToSuppressionListTasks HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: application/xml
User-Agent: Jakarta Commons-HttpClient/3.1
Host: api.esv2.com
Content-Length: 379
<ApiRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<ApiKey>test_api_key1</ApiKey>
<Data>
<Source>
<Url>ftp://ftp.expertsender.com/SuppressionLists/test.csv</Url>
</Source>
<Target>
<Name>API test import </Name>
<SuppressionList>80</SuppressionList>
</Target>
</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: Tue, 27 Mar 2012 12: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>24</Data>
</ApiResponse>
Scheduling a new subscribers suppression list import with full options
Request:
POST https://api.esv2.com/v2/Api/ImportToSuppressionListTasks HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: application/xml;charset=UTF-8
User-Agent: Jakarta Commons-HttpClient/3.1
Host: api.esv2.com
Content-Length: 1210
<ApiRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<ApiKey>test_api_key1</ApiKey>
<Data>
<Source>
<Url>ftp://ftp.expertsender.com/SuppressionLists/test.csv</Url>
<Username>username</Username>
<Password>password</Password>
<FtpAuth>ExplicitTls</FtpAuth>
<FtpUseActiveMode>true</FtpUseActiveMode>
</Source>
<Target>
<Name>API test import </Name>
<SuppressionList>80</SuppressionList>
</Target>
<ImportSetup>
<Mode>Add</Mode>
<EntryType>DialingPrefix</EntryType>
<Delimiter>,</Delimiter>
<Quote>"</Quote>
<Escape>"</Escape>
<Comment>|</Comment>
<Encoding>UTF-8</Encoding>
<ColumnNumber>0</ColumnNumber>
</ImportSetup>
</Data>
</ApiRequest>
Report abuse