{"id":10922,"date":"2024-06-25T10:20:33","date_gmt":"2024-06-25T09:20:33","guid":{"rendered":"https:\/\/help.expertsender.com\/?post_type=es&#038;p=10922"},"modified":"2024-06-25T12:21:57","modified_gmt":"2024-06-25T11:21:57","slug":"start-suppression-list-export","status":"publish","type":"es","link":"https:\/\/help.expertsender.com\/pl\/emp\/api\/start-suppression-list-export\/","title":{"rendered":"Start suppression list export"},"content":{"rendered":"\n<p>Suppression list exports collection allows scheduling (asynchronous) exports of suppression lists. Data is exported in CSV format.<\/p>\n\n\n\n<p>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.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"h.h6bqht1y7b_l\"><strong>Request data format<\/strong><\/h3>\n\n\n\n<p>Data part of request for scheduling an export.<\/p>\n\n\n\n<p>Data element children:<\/p>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td><strong>Element\/attribute<\/strong><\/td><td><strong>Type<\/strong><\/td><td><strong>Notes<\/strong><\/td><\/tr><tr><td>ListId<\/td><td>integer<\/td><td>ID of subscriber suppression list to export.<\/td><\/tr><tr><td>EntryType<\/td><td>string<\/td><td>The type of column to be exported. There are 6 options for selecting the type of exported column. Default email<br>Email<br>Md5<br>Sha256<br>Domain<br>For customers with SMS\/MMS integration enabled there are export type available<br>Phone<br>DialingPrefix<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"h.ishdsz97e8hx_l\"><strong>Response<\/strong><\/h3>\n\n\n\n<p>Method returns ID of scheduled export. ID can be used to get export status using GET method.<\/p>\n\n\n\n<p>Response Data element:<\/p>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td><strong>Element\/attribute<\/strong><\/td><td><strong>Type<\/strong><\/td><td><strong>Notes<\/strong><\/td><\/tr><tr><td>(Data element content)<\/td><td>int<\/td><td>ID of scheduled export.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"h.kaueqiiel200_l\"><strong>Examples<\/strong><\/h3>\n\n\n\n<p><strong>Simple suppression list export<\/strong><\/p>\n\n\n\n<p>Request:<\/p>\n\n\n\n<div class=\"wp-block-kevinbatdorf-code-block-pro cbp-has-line-numbers\" data-code-block-pro-font-family=\"Code-Pro-JetBrains-Mono\" style=\"font-size:.875rem;font-family:Code-Pro-JetBrains-Mono,ui-monospace,SFMono-Regular,Menlo,Monaco,Consolas,monospace;--cbp-line-number-color:#babed8;--cbp-line-number-width:calc(2 * 0.6 * .875rem);line-height:1.25rem;--cbp-tab-width:2;tab-size:var(--cbp-tab-width, 2)\"><span role=\"button\" tabindex=\"0\" data-code=\"POST https:\/\/api.esv2.com\/v2\/Api\/SuppressionListExports HTTP\/1.1 \nAccept-Encoding: gzip,deflate \nContent-Type: application\/xml \nUser-Agent: Jakarta Commons-HttpClient\/3.1 \nHost: api.esv2.com \nContent-Length: 411 \n\n&lt;ApiRequest xmlns:xsi=&quot;http:\/\/www.w3.org\/2001\/XMLSchema-instance&quot; xmlns:xs=&quot;http:\/\/www.w3.org\/2001\/XMLSchema&quot;&gt;\n  &lt;ApiKey&gt;test_api_key1&lt;\/ApiKey&gt;\n  &lt;Data&gt;\n    &lt;ListId&gt;11&lt;\/ListId&gt;\n    &lt;EntryType&gt;Domain&lt;\/EntryType&gt;\n  &lt;\/Data&gt;\n&lt;\/ApiRequest&gt;\" style=\"color:#babed8;display:none\" aria-label=\"Copy\" class=\"code-block-pro-copy-button\"><svg xmlns=\"http:\/\/www.w3.org\/2000\/svg\" style=\"width:24px;height:24px\" fill=\"none\" viewBox=\"0 0 24 24\" stroke=\"currentColor\" stroke-width=\"2\"><path class=\"with-check\" stroke-linecap=\"round\" stroke-linejoin=\"round\" d=\"M4.5 12.75l6 6 9-13.5\"><\/path><path class=\"without-check\" stroke-linecap=\"round\" stroke-linejoin=\"round\" d=\"M16.5 8.25V6a2.25 2.25 0 00-2.25-2.25H6A2.25 2.25 0 003.75 6v8.25A2.25 2.25 0 006 16.5h2.25m8.25-8.25H18a2.25 2.25 0 012.25 2.25V18A2.25 2.25 0 0118 20.25h-7.5A2.25 2.25 0 018.25 18v-1.5m8.25-8.25h-6a2.25 2.25 0 00-2.25 2.25v6\"><\/path><\/svg><\/span><pre class=\"shiki material-theme-palenight\" style=\"background-color: #292D3E\" tabindex=\"0\"><code><span class=\"line\"><span style=\"color: #BABED8\">POST https:\/\/api.esv2.com\/v2\/Api\/SuppressionListExports HTTP\/1.1 <\/span><\/span>\n<span class=\"line\"><span style=\"color: #BABED8\">Accept-Encoding: gzip,deflate <\/span><\/span>\n<span class=\"line\"><span style=\"color: #BABED8\">Content-Type: application\/xml <\/span><\/span>\n<span class=\"line\"><span style=\"color: #BABED8\">User-Agent: Jakarta Commons-HttpClient\/3.1 <\/span><\/span>\n<span class=\"line\"><span style=\"color: #BABED8\">Host: api.esv2.com <\/span><\/span>\n<span class=\"line\"><span style=\"color: #BABED8\">Content-Length: 411 <\/span><\/span>\n<span class=\"line\"><\/span>\n<span class=\"line\"><span style=\"color: #89DDFF\">&lt;<\/span><span style=\"color: #F07178\">ApiRequest<\/span><span style=\"color: #89DDFF\"> <\/span><span style=\"color: #C792EA\">xmlns<\/span><span style=\"color: #89DDFF\">:<\/span><span style=\"color: #C792EA\">xsi<\/span><span style=\"color: #89DDFF\">=<\/span><span style=\"color: #89DDFF\">&quot;<\/span><span style=\"color: #C3E88D\">http:\/\/www.w3.org\/2001\/XMLSchema-instance<\/span><span style=\"color: #89DDFF\">&quot;<\/span><span style=\"color: #89DDFF\"> <\/span><span style=\"color: #C792EA\">xmlns<\/span><span style=\"color: #89DDFF\">:<\/span><span style=\"color: #C792EA\">xs<\/span><span style=\"color: #89DDFF\">=<\/span><span style=\"color: #89DDFF\">&quot;<\/span><span style=\"color: #C3E88D\">http:\/\/www.w3.org\/2001\/XMLSchema<\/span><span style=\"color: #89DDFF\">&quot;<\/span><span style=\"color: #89DDFF\">&gt;<\/span><\/span>\n<span class=\"line\"><span style=\"color: #BABED8\">  <\/span><span style=\"color: #89DDFF\">&lt;<\/span><span style=\"color: #F07178\">ApiKey<\/span><span style=\"color: #89DDFF\">&gt;<\/span><span style=\"color: #BABED8\">test_api_key1<\/span><span style=\"color: #89DDFF\">&lt;\/<\/span><span style=\"color: #F07178\">ApiKey<\/span><span style=\"color: #89DDFF\">&gt;<\/span><\/span>\n<span class=\"line\"><span style=\"color: #BABED8\">  <\/span><span style=\"color: #89DDFF\">&lt;<\/span><span style=\"color: #F07178\">Data<\/span><span style=\"color: #89DDFF\">&gt;<\/span><\/span>\n<span class=\"line\"><span style=\"color: #BABED8\">    <\/span><span style=\"color: #89DDFF\">&lt;<\/span><span style=\"color: #F07178\">ListId<\/span><span style=\"color: #89DDFF\">&gt;<\/span><span style=\"color: #BABED8\">11<\/span><span style=\"color: #89DDFF\">&lt;\/<\/span><span style=\"color: #F07178\">ListId<\/span><span style=\"color: #89DDFF\">&gt;<\/span><\/span>\n<span class=\"line\"><span style=\"color: #BABED8\">    <\/span><span style=\"color: #89DDFF\">&lt;<\/span><span style=\"color: #F07178\">EntryType<\/span><span style=\"color: #89DDFF\">&gt;<\/span><span style=\"color: #BABED8\">Domain<\/span><span style=\"color: #89DDFF\">&lt;\/<\/span><span style=\"color: #F07178\">EntryType<\/span><span style=\"color: #89DDFF\">&gt;<\/span><\/span>\n<span class=\"line\"><span style=\"color: #BABED8\">  <\/span><span style=\"color: #89DDFF\">&lt;\/<\/span><span style=\"color: #F07178\">Data<\/span><span style=\"color: #89DDFF\">&gt;<\/span><\/span>\n<span class=\"line\"><span style=\"color: #89DDFF\">&lt;\/<\/span><span style=\"color: #F07178\">ApiRequest<\/span><span style=\"color: #89DDFF\">&gt;<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n<p>Response:<\/p>\n\n\n\n<div class=\"wp-block-kevinbatdorf-code-block-pro cbp-has-line-numbers\" data-code-block-pro-font-family=\"Code-Pro-JetBrains-Mono\" style=\"font-size:.875rem;font-family:Code-Pro-JetBrains-Mono,ui-monospace,SFMono-Regular,Menlo,Monaco,Consolas,monospace;--cbp-line-number-color:#babed8;--cbp-line-number-width:calc(2 * 0.6 * .875rem);line-height:1.25rem;--cbp-tab-width:2;tab-size:var(--cbp-tab-width, 2)\"><span role=\"button\" tabindex=\"0\" data-code=\"HTTP\/1.1 201 Created \nCache-Control: private \nContent-Type: text\/xml; charset=utf-8 \nServer: Microsoft-IIS\/7.5 \nX-AspNetMvc-Version: 3.0 \nX-AspNet-Version: 4.0.30319 \nX-Powered-By: ASP.NET \nDate: Mon, 25 Nov 2013 16:40:14 GMT \nContent-Length: 147  \n\n&lt;ApiResponse xmlns:xsd=&quot;http:\/\/www.w3.org\/2001\/XMLSchema&quot; xmlns:xsi=&quot;http:\/\/www.w3.org\/2001\/XMLSchema-instance&quot;&gt;\n  &lt;Data&gt;12&lt;\/Data&gt;\n&lt;\/ApiResponse&gt;\" style=\"color:#babed8;display:none\" aria-label=\"Copy\" class=\"code-block-pro-copy-button\"><svg xmlns=\"http:\/\/www.w3.org\/2000\/svg\" style=\"width:24px;height:24px\" fill=\"none\" viewBox=\"0 0 24 24\" stroke=\"currentColor\" stroke-width=\"2\"><path class=\"with-check\" stroke-linecap=\"round\" stroke-linejoin=\"round\" d=\"M4.5 12.75l6 6 9-13.5\"><\/path><path class=\"without-check\" stroke-linecap=\"round\" stroke-linejoin=\"round\" d=\"M16.5 8.25V6a2.25 2.25 0 00-2.25-2.25H6A2.25 2.25 0 003.75 6v8.25A2.25 2.25 0 006 16.5h2.25m8.25-8.25H18a2.25 2.25 0 012.25 2.25V18A2.25 2.25 0 0118 20.25h-7.5A2.25 2.25 0 018.25 18v-1.5m8.25-8.25h-6a2.25 2.25 0 00-2.25 2.25v6\"><\/path><\/svg><\/span><pre class=\"shiki material-theme-palenight\" style=\"background-color: #292D3E\" tabindex=\"0\"><code><span class=\"line\"><span style=\"color: #BABED8\">HTTP\/1.1 201 Created <\/span><\/span>\n<span class=\"line\"><span style=\"color: #BABED8\">Cache-Control: private <\/span><\/span>\n<span class=\"line\"><span style=\"color: #BABED8\">Content-Type: text\/xml; charset=utf-8 <\/span><\/span>\n<span class=\"line\"><span style=\"color: #BABED8\">Server: Microsoft-IIS\/7.5 <\/span><\/span>\n<span class=\"line\"><span style=\"color: #BABED8\">X-AspNetMvc-Version: 3.0 <\/span><\/span>\n<span class=\"line\"><span style=\"color: #BABED8\">X-AspNet-Version: 4.0.30319 <\/span><\/span>\n<span class=\"line\"><span style=\"color: #BABED8\">X-Powered-By: ASP.NET <\/span><\/span>\n<span class=\"line\"><span style=\"color: #BABED8\">Date: Mon, 25 Nov 2013 16:40:14 GMT <\/span><\/span>\n<span class=\"line\"><span style=\"color: #BABED8\">Content-Length: 147  <\/span><\/span>\n<span class=\"line\"><\/span>\n<span class=\"line\"><span style=\"color: #89DDFF\">&lt;<\/span><span style=\"color: #F07178\">ApiResponse<\/span><span style=\"color: #89DDFF\"> <\/span><span style=\"color: #C792EA\">xmlns<\/span><span style=\"color: #89DDFF\">:<\/span><span style=\"color: #C792EA\">xsd<\/span><span style=\"color: #89DDFF\">=<\/span><span style=\"color: #89DDFF\">&quot;<\/span><span style=\"color: #C3E88D\">http:\/\/www.w3.org\/2001\/XMLSchema<\/span><span style=\"color: #89DDFF\">&quot;<\/span><span style=\"color: #89DDFF\"> <\/span><span style=\"color: #C792EA\">xmlns<\/span><span style=\"color: #89DDFF\">:<\/span><span style=\"color: #C792EA\">xsi<\/span><span style=\"color: #89DDFF\">=<\/span><span style=\"color: #89DDFF\">&quot;<\/span><span style=\"color: #C3E88D\">http:\/\/www.w3.org\/2001\/XMLSchema-instance<\/span><span style=\"color: #89DDFF\">&quot;<\/span><span style=\"color: #89DDFF\">&gt;<\/span><\/span>\n<span class=\"line\"><span style=\"color: #BABED8\">  <\/span><span style=\"color: #89DDFF\">&lt;<\/span><span style=\"color: #F07178\">Data<\/span><span style=\"color: #89DDFF\">&gt;<\/span><span style=\"color: #BABED8\">12<\/span><span style=\"color: #89DDFF\">&lt;\/<\/span><span style=\"color: #F07178\">Data<\/span><span style=\"color: #89DDFF\">&gt;<\/span><\/span>\n<span class=\"line\"><span style=\"color: #89DDFF\">&lt;\/<\/span><span style=\"color: #F07178\">ApiResponse<\/span><span style=\"color: #89DDFF\">&gt;<\/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-10922","es","type-es","status-publish","format-standard","hentry"],"acf":[],"_links":{"self":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/10922","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":1,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/10922\/revisions"}],"predecessor-version":[{"id":10923,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/10922\/revisions\/10923"}],"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=10922"}],"wp:term":[{"taxonomy":"emp-category","embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/emp-category?post=10922"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}