{"id":10908,"date":"2024-06-25T10:12:08","date_gmt":"2024-06-25T09:12:08","guid":{"rendered":"https:\/\/help.expertsender.com\/?post_type=es&p=10908"},"modified":"2024-06-25T12:21:47","modified_gmt":"2024-06-25T11:21:47","slug":"import-to-suppression-lists","status":"publish","type":"es","link":"https:\/\/help.expertsender.com\/pl\/emp\/api\/import-to-suppression-lists\/","title":{"rendered":"Import to Suppression Lists"},"content":{"rendered":"\n

ImportToSuppressionListTasks collection allows scheduling (asynchronous) imports to suppression lists. Subscribers are imported from an external source, e.g. file stored on FTP server. <\/p>\n\n\n\n

Currently, only one-time, immediately executed imports are supported. <\/p>\n\n\n\n

Executing a GET request on ImportToSuppressionListTasks collection allows polling for scheduled import status (e.g. if it is still in progress or already finished).<\/p>\n\n\n\n

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

Data part of request for scheduling a new import to suppression list.<\/p>\n\n\n\n

Data element children:<\/p>\n\n\n\n

Element\/attribute<\/strong><\/td>Type<\/strong><\/td>Notes<\/strong><\/td><\/tr>
Source<\/td>complex<\/td>Imported file information. Required.<\/td><\/tr>
Target<\/td>complex<\/td>Target suppression list data. Required.<\/td><\/tr>
ImportSetup<\/td>complex<\/td>Import settings, file settings, column mapping etc. Optional. If omitted, default settings will be used.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Source element children:\u00a0<\/p>\n\n\n\n

Element\/attribute<\/strong><\/td>Type<\/strong><\/td>Notes<\/strong><\/td><\/tr>
Url<\/td>string<\/td>
URL address of imported file. Supported protocols are HTTP, HTTPS, FTP, FTPS and SFTP. E.g. ftp:\/\/www.domain.com\/myimportedfile.csv<\/td><\/tr>
Username<\/td>string<\/td>Username used for authentication. Optional.<\/td><\/tr>
Password<\/td>string<\/td>
Password used for authentication. Optional.<\/td><\/tr>
FtpAuth<\/td>string<\/td>Authentication method for secure FTP servers. Optional. Valid values are:None – FTP server does not support secure authentication (default)
ExplicitTls – Explicit TLS\/SSL authentication
ExplicitSsl – Explicit SSL only authentication
ImplicitSsl – Implicit SSL authentication<\/td><\/tr>
FtpUseActiveMode<\/td>string<\/td>If set to “true”, active mode will be used for FTP connections. Default value is “false” – passive connection mode will be used.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Target element children:\u00a0<\/p>\n\n\n\n

Element\/attribute<\/strong><\/td>Type<\/strong><\/td>Notes<\/strong><\/td><\/tr>
Name<\/td>string<\/td>Import name. Used internally for easier identification. Required.<\/td><\/tr>
SuppressionList<\/td>integer<\/td>ID of suppression list that records will be imported to. Required.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

ImportSetup element children:\u00a0<\/p>\n\n\n\n

Element\/attribute<\/strong><\/td>Type<\/strong><\/td>Notes<\/strong><\/td><\/tr>
Mode<\/td>string<\/td>Import mode. Optional. Defaults to “Add”.<\/td><\/tr>
EntryType<\/td>string<\/td>Type of entries to be added. It matters only when importing to an SMS type list. The available options are “Phone” and “DialingPrefix”. Optional. Defaults to “Phone”.<\/td><\/tr>
Delimiter<\/td>string<\/td>CSV file delimiter. Optional. Default value is ‘,’ (comma).<\/td><\/tr>
Quote<\/td>string<\/td>CSV file quoting character. Optional. Default value is ‘”‘ (double quote).<\/td><\/tr>
Escape<\/td>string<\/td>CSV file escape character. Optional. Default value is ‘”‘ (double quote).<\/td><\/tr>
Comment<\/td>string<\/td>CSV file comment character. Optional. Default value is zero-byte (undefined).<\/td><\/tr>
Encoding<\/td>string<\/td>CSV file encoding. Optional. Default is “utf-8”<\/td><\/tr>
ColumnNumber<\/td>string<\/td>The column number in the file we will import. Optional. Default is 0 – that is, the first column.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Supported import modes:\u00a0<\/p>\n\n\n\n

Mode<\/strong><\/td>Behaviour<\/strong><\/td><\/tr>
Add<\/td>Add new records to the suppression list.<\/td><\/tr>
Synchronize<\/td>Whole suppression list will be replaced with imported file content.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Response<\/strong><\/h3>\n\n\n\n

Method returns ID of scheduled import. ID can be used to get import status using GET method.<\/p>\n\n\n\n

Response Data element:<\/p>\n\n\n\n

Element\/attribute<\/strong><\/td>Type<\/strong><\/td>Notes<\/strong><\/td><\/tr>
(Data element content)<\/td>int<\/td>ID of scheduled import.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Examples<\/strong><\/h3>\n\n\n\n

Scheduling a new subscribers suppression list import with default options <\/strong><\/p>\n\n\n\n

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

<\/path><\/path><\/svg><\/span>
POST https:\/\/api.esv2.com\/v2\/Api\/ImportToSuppressionListTasks HTTP\/1.1 <\/span><\/span>\nAccept-Encoding: gzip,deflate <\/span><\/span>\nContent-Type: application\/xml <\/span><\/span>\nUser-Agent: Jakarta Commons-HttpClient\/3.1 <\/span><\/span>\nHost: api.esv2.com <\/span><\/span>\nContent-Length: 379  <\/span><\/span>\n<\/span>\n <\/span><<\/span>ApiRequest<\/span> <\/span>xmlns<\/span>:<\/span>xsi<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema-instance<\/span>"<\/span> <\/span>xmlns<\/span>:<\/span>xs<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema<\/span>"<\/span>><\/span><\/span>\n   <\/span><<\/span>ApiKey<\/span>><\/span>test_api_key1<\/span><\/<\/span>ApiKey<\/span>><\/span><\/span>\n   <\/span><<\/span>Data<\/span>><\/span><\/span>\n     <\/span><<\/span>Source<\/span>><\/span><\/span>\n             <\/span><<\/span>Url<\/span>><\/span>ftp:\/\/ftp.expertsender.com\/SuppressionLists\/test.csv<\/span><\/<\/span>Url<\/span>><\/span><\/span>\n     <\/span><\/<\/span>Source<\/span>><\/span><\/span>\n     <\/span><<\/span>Target<\/span>><\/span><\/span>\n       <\/span><<\/span>Name<\/span>><\/span>API test import <\/span><\/<\/span>Name<\/span>><\/span><\/span>\n       <\/span><<\/span>SuppressionList<\/span>><\/span>80<\/span><\/<\/span>SuppressionList<\/span>><\/span><\/span>\n     <\/span><\/<\/span>Target<\/span>><\/span><\/span>\n   <\/span><\/<\/span>Data<\/span>><\/span><\/span>\n <\/span><\/<\/span>ApiRequest<\/span>><\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Response:\u00a0<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
HTTP\/1.1 201 Created <\/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: 3.0 <\/span><\/span>\nX-AspNet-Version: 4.0.30319 <\/span><\/span>\nX-Powered-By: ASP.NET <\/span><\/span>\nDate: Tue, 27 Mar 2012 12:40:14 GMT <\/span><\/span>\nContent-Length: 147  <\/span><\/span>\n<\/span>\n <\/span><<\/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>24<\/span><\/<\/span>Data<\/span>><\/span><\/span>\n <\/span><\/<\/span>ApiResponse<\/span>><\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Scheduling a new subscribers suppression list import with full options <\/strong><\/p>\n\n\n\n
Request:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
POST https:\/\/api.esv2.com\/v2\/Api\/ImportToSuppressionListTasks HTTP\/1.1 <\/span><\/span>\nAccept-Encoding: gzip,deflate <\/span><\/span>\nContent-Type: application\/xml;charset=UTF-8 <\/span><\/span>\nUser-Agent: Jakarta Commons-HttpClient\/3.1 <\/span><\/span>\nHost: api.esv2.com <\/span><\/span>\nContent-Length: 1210  <\/span><\/span>\n<\/span>\n <\/span><<\/span>ApiRequest<\/span> <\/span>xmlns<\/span>:<\/span>xsi<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema-instance<\/span>"<\/span> <\/span>xmlns<\/span>:<\/span>xs<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema<\/span>"<\/span>><\/span><\/span>\n   <\/span><<\/span>ApiKey<\/span>><\/span>test_api_key1<\/span><\/<\/span>ApiKey<\/span>><\/span><\/span>\n   <\/span><<\/span>Data<\/span>><\/span><\/span>\n     <\/span><<\/span>Source<\/span>><\/span>    <\/span><\/span>\n        <\/span><<\/span>Url<\/span>><\/span>ftp:\/\/ftp.expertsender.com\/SuppressionLists\/test.csv<\/span><\/<\/span>Url<\/span>><\/span><\/span>\n       <\/span><<\/span>Username<\/span>><\/span>username<\/span><\/<\/span>Username<\/span>><\/span><\/span>\n       <\/span><<\/span>Password<\/span>><\/span>password<\/span><\/<\/span>Password<\/span>><\/span><\/span>\n     <\/span><<\/span>FtpAuth<\/span>><\/span>ExplicitTls<\/span><\/<\/span>FtpAuth<\/span>><\/span><\/span>\n     <\/span><<\/span>FtpUseActiveMode<\/span>><\/span>true<\/span><\/<\/span>FtpUseActiveMode<\/span>><\/span><\/span>\n     <\/span><\/<\/span>Source<\/span>><\/span><\/span>\n     <\/span><<\/span>Target<\/span>><\/span><\/span>\n       <\/span><<\/span>Name<\/span>><\/span>API test import <\/span><\/<\/span>Name<\/span>><\/span><\/span>\n       <\/span><<\/span>SuppressionList<\/span>><\/span>80<\/span><\/<\/span>SuppressionList<\/span>><\/span><\/span>\n     <\/span><\/<\/span>Target<\/span>><\/span><\/span>\n     <\/span><<\/span>ImportSetup<\/span>><\/span><\/span>\n       <\/span><<\/span>Mode<\/span>><\/span>Add<\/span><\/<\/span>Mode<\/span>><\/span><\/span>\n     <\/span><<\/span>EntryType<\/span>><\/span>DialingPrefix<\/span><\/<\/span>EntryType<\/span>><\/span><\/span>\n       <\/span><<\/span>Delimiter<\/span>><\/span>,<\/span><\/<\/span>Delimiter<\/span>><\/span><\/span>\n       <\/span><<\/span>Quote<\/span>><\/span>"<\/span><\/<\/span>Quote<\/span>><\/span><\/span>\n       <\/span><<\/span>Escape<\/span>><\/span>"<\/span><\/<\/span>Escape<\/span>><\/span><\/span>\n       <\/span><<\/span>Comment<\/span>><\/span>|<\/span><\/<\/span>Comment<\/span>><\/span><\/span>\n       <\/span><<\/span>Encoding<\/span>><\/span>UTF-8<\/span><\/<\/span>Encoding<\/span>><\/span> <\/span><\/span>\n     <\/span><<\/span>ColumnNumber<\/span>><\/span>0<\/span><\/<\/span>ColumnNumber<\/span>><\/span><\/span>\n     <\/span><\/<\/span>ImportSetup<\/span>><\/span><\/span>\n   <\/span><\/<\/span>Data<\/span>><\/span><\/span>\n <\/span><\/<\/span>ApiRequest<\/span>><\/span><\/span><\/code><\/pre><\/div>\n","protected":false},"author":13,"featured_media":0,"parent":3551,"menu_order":0,"template":"","format":"standard","emp-category":[],"class_list":["post-10908","es","type-es","status-publish","format-standard","hentry"],"acf":[],"_links":{"self":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/10908","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\/13"}],"version-history":[{"count":3,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/10908\/revisions"}],"predecessor-version":[{"id":10911,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/10908\/revisions\/10911"}],"up":[{"embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3551"}],"wp:attachment":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/media?parent=10908"}],"wp:term":[{"taxonomy":"emp-category","embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/emp-category?post=10908"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}