{"id":3765,"date":"2023-08-31T08:39:10","date_gmt":"2023-08-31T07:39:10","guid":{"rendered":"https:\/\/help.expertsender.com\/?post_type=es&#038;p=3765"},"modified":"2024-06-25T13:10:01","modified_gmt":"2024-06-25T12:10:01","slug":"add-to-local-blacklist","status":"publish","type":"es","link":"https:\/\/help.expertsender.com\/pl\/emp\/api\/methods\/local-blacklist\/add-to-local-blacklist\/","title":{"rendered":"Add to local blacklist"},"content":{"rendered":"\n<p>Used to add a single entry to a local blacklist . Successful request returns \u201c201 \u2013 Created\u201d HTTP code and empty response body.<\/p>\n\n\n\n<p>Request URL parameters:&nbsp;<\/p>\n\n\n\n<figure class=\"wp-block-table\"><table><thead><tr><th>Element\/attribute<\/th><th>Type<\/th><th>Notes<\/th><\/tr><\/thead><tbody><tr><td>apiKey<\/td><td>string<\/td><td>Your API key, required for authentication. Required.<\/td><\/tr><tr><td>entry<\/td><td>string<\/td><td>Entry to add to local black list. A valid entry can be:<br>email, e.g. username@domain.com<br>domain, e.g. domain.com<br>MD5, e.g. 2c2ba4dc950fd1162c47b08fdcfabe24\u00a0<br>sha256, e.g. CECD4BD504D40A832E106CFF3356D8C401D569CF771433E3F1ACE4FA31666550\u00a0<br>phone,e.g. 48501202365<br>dialing prefix, e.g. 48Required.<\/td><\/tr><tr><td>entryType&nbsp;<\/td><td>string<\/td><td>Type of added record to local blacklist. Entry will be validated according to specified type. Valid values:<br>domain<br>md5<br>sha256<br>phone<br>prefix<br>Optional. Defaults to &#8220;email&#8221;. \u00a0<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<p>This method will ignore duplicated values on local blacklist. You will not receive an error when trying to add an email address (or domain, MD5, SHA256, phone, prefix) that is already present on local blacklist.<\/p>\n\n\n\n<p>You will receive an error when sending an invalid or empty entry, though.<\/p>\n\n\n\n<p>Example URLs:<\/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:#A6ACCD;--cbp-line-number-width:8.4375px;line-height:1.25rem;--cbp-tab-width:2;tab-size:var(--cbp-tab-width, 2)\"><span role=\"button\" tabindex=\"0\" data-code=\"https:\/\/api.esv2.com \/v2\/Api\/LocalBlacklist?apiKey=test_api_key1&amp;entry=lbl_test@domain.com \nhttps:\/\/api.esv2.com\/v2\/Api\/LocalBlacklist?apiKey=test_api_key1&amp;entry=lbltest.com&amp;entryType=domain \nhttps:\/\/api.esv2.com\/v2\/Api\/LocalBlacklist?apiKey=test_api_key1&amp;entry=25522A4A65882F8FD23A4C56F7C92A31&amp;entryType=md5 \nhttps:\/\/api.esv2.com\/v2\/Api\/LocalBlacklist?apiKey=test_api_key1&amp;entry=CECD4BD504D40A832E106CFF3356D8C401D569CF771433E3F1ACE4FA31666550&amp;entryType=sha256 \nhttps:\/\/api.esv2.com\/v2\/Api\/LocalBlacklist?apiKey=test_api_key1&amp;entry=+48880123456&amp;entryType=phone \nhttps:\/\/api.esv2.com\/v2\/Api\/LocalBlacklist?apiKey=test_api_key1&amp;entry=48&amp;entryType=prefix \" style=\"color:#A6ACCD;display:none\" aria-label=\"Copy\" class=\"code-block-pro-copy-button\"><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: #A6ACCD\">https:\/\/api.esv2.com \/v2\/Api\/LocalBlacklist?apiKey=test_api_key1&amp;entry=lbl_test@domain.com <\/span><\/span>\n<span class=\"line\"><\/span>\n<span class=\"line\"><span style=\"color: #A6ACCD\">https:\/\/api.esv2.com\/v2\/Api\/LocalBlacklist?apiKey=test_api_key1&amp;entry=lbltest.com&amp;entryType=domain <\/span><\/span>\n<span class=\"line\"><\/span>\n<span class=\"line\"><span style=\"color: #A6ACCD\">https:\/\/api.esv2.com\/v2\/Api\/LocalBlacklist?apiKey=test_api_key1&amp;entry=25522A4A65882F8FD23A4C56F7C92A31&amp;entryType=md5 <\/span><\/span>\n<span class=\"line\"><\/span>\n<span class=\"line\"><span style=\"color: #A6ACCD\">https:\/\/api.esv2.com\/v2\/Api\/LocalBlacklist?apiKey=test_api_key1&amp;entry=CECD4BD504D40A832E106CFF3356D8C401D569CF771433E3F1ACE4FA31666550&amp;entryType=sha256 <\/span><\/span>\n<span class=\"line\"><\/span>\n<span class=\"line\"><span style=\"color: #A6ACCD\">https:\/\/api.esv2.com\/v2\/Api\/LocalBlacklist?apiKey=test_api_key1&amp;entry=+48880123456&amp;entryType=phone <\/span><\/span>\n<span class=\"line\"><\/span>\n<span class=\"line\"><span style=\"color: #A6ACCD\">https:\/\/api.esv2.com\/v2\/Api\/LocalBlacklist?apiKey=test_api_key1&amp;entry=48&amp;entryType=prefix <\/span><\/span><\/code><\/pre><\/div>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"h.3oqr424ubo3q_l\"><strong>Examples<\/strong><\/h3>\n\n\n\n<p>Request:&nbsp;<\/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:#A6ACCD;--cbp-line-number-width:8.4375px;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\/LocalBlacklist?apiKey=test_api_key1&amp;entry=lbl_test@domain.com HTTP\/1.1 \nAccept-Encoding: gzip,deflate \nContent-Type: application\/x-www-form-urlencoded \nUser-Agent: Jakarta Commons-HttpClient\/3.1 \nHost: localapi \nContent-Length: 0\" style=\"color:#A6ACCD;display:none\" aria-label=\"Copy\" class=\"code-block-pro-copy-button\"><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: #A6ACCD\">POST https:\/\/api.esv2.com \/v2\/Api\/LocalBlacklist?apiKey=test_api_key1&amp;entry=lbl_test@domain.com HTTP\/1.1 <\/span><\/span>\n<span class=\"line\"><span style=\"color: #A6ACCD\">Accept-Encoding: gzip,deflate <\/span><\/span>\n<span class=\"line\"><span style=\"color: #A6ACCD\">Content-Type: application\/x-www-form-urlencoded <\/span><\/span>\n<span class=\"line\"><span style=\"color: #A6ACCD\">User-Agent: Jakarta Commons-HttpClient\/3.1 <\/span><\/span>\n<span class=\"line\"><span style=\"color: #A6ACCD\">Host: localapi <\/span><\/span>\n<span class=\"line\"><span style=\"color: #A6ACCD\">Content-Length: 0<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n<p>OK response:&nbsp;<\/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:#A6ACCD;--cbp-line-number-width:8.4375px;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 \nServer: Microsoft-IIS\/7.5 \nX-AspNetMvc-Version: 2.0 \nX-AspNet-Version: 2.0.50727 \nSet-Cookie: TIMEZONE=Central European Standard Time; path=\/ \nX-Powered-By: ASP.NET \nDate: Wed, 19 Oct 2011 12:10:34 GMT \nContent-Length: 0\" style=\"color:#A6ACCD;display:none\" aria-label=\"Copy\" class=\"code-block-pro-copy-button\"><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: #A6ACCD\">HTTP\/1.1 201 Created <\/span><\/span>\n<span class=\"line\"><span style=\"color: #A6ACCD\">Cache-Control: private <\/span><\/span>\n<span class=\"line\"><span style=\"color: #A6ACCD\">Server: Microsoft-IIS\/7.5 <\/span><\/span>\n<span class=\"line\"><span style=\"color: #A6ACCD\">X-AspNetMvc-Version: 2.0 <\/span><\/span>\n<span class=\"line\"><span style=\"color: #A6ACCD\">X-AspNet-Version: 2.0.50727 <\/span><\/span>\n<span class=\"line\"><span style=\"color: #A6ACCD\">Set-Cookie: TIMEZONE=Central European Standard Time; path=\/ <\/span><\/span>\n<span class=\"line\"><span style=\"color: #A6ACCD\">X-Powered-By: ASP.NET <\/span><\/span>\n<span class=\"line\"><span style=\"color: #A6ACCD\">Date: Wed, 19 Oct 2011 12:10:34 GMT <\/span><\/span>\n<span class=\"line\"><span style=\"color: #A6ACCD\">Content-Length: 0<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n<p>Error&nbsp;response:&nbsp;<\/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:#A6ACCD;--cbp-line-number-width:16.859375px;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 400 Bad Request \nCache-Control: private \nContent-Type: text\/xml; charset=utf-8 \nServer: Microsoft-IIS\/7.5 \nX-AspNetMvc-Version: 2.0 \nX-AspNet-Version: 2.0.50727 \nSet-Cookie: TIMEZONE=Central European Standard Time; path=\/ \nX-Powered-By: ASP.NET \nDate: Wed, 19 Oct 2011 12:12:36 GMT \nContent-Length: 271 \n&lt;ApiResponse xmlns_xsi=&quot;http:\/\/www.w3.org\/2001\/XMLSchema-instance&quot; xmlns_xsd=&quot;http:\/\/www.w3.org\/2001\/XMLSchema&quot;&gt;\n   &lt;ErrorMessage&gt;\n     &lt;Code&gt;400&lt;\/Code&gt;\n     &lt;Message&gt;Entry is not a valid SHA256.&lt;\/Message&gt;\n   &lt;\/ErrorMessage&gt;\n&lt;\/ApiResponse&gt;\" style=\"color:#A6ACCD;display:none\" aria-label=\"Copy\" class=\"code-block-pro-copy-button\"><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: #A6ACCD\">HTTP\/1.1 400 Bad Request <\/span><\/span>\n<span class=\"line\"><span style=\"color: #A6ACCD\">Cache-Control: private <\/span><\/span>\n<span class=\"line\"><span style=\"color: #A6ACCD\">Content-Type: text\/xml; charset=utf-8 <\/span><\/span>\n<span class=\"line\"><span style=\"color: #A6ACCD\">Server: Microsoft-IIS\/7.5 <\/span><\/span>\n<span class=\"line\"><span style=\"color: #A6ACCD\">X-AspNetMvc-Version: 2.0 <\/span><\/span>\n<span class=\"line\"><span style=\"color: #A6ACCD\">X-AspNet-Version: 2.0.50727 <\/span><\/span>\n<span class=\"line\"><span style=\"color: #A6ACCD\">Set-Cookie: TIMEZONE=Central European Standard Time; path=\/ <\/span><\/span>\n<span class=\"line\"><span style=\"color: #A6ACCD\">X-Powered-By: ASP.NET <\/span><\/span>\n<span class=\"line\"><span style=\"color: #A6ACCD\">Date: Wed, 19 Oct 2011 12:12:36 GMT <\/span><\/span>\n<span class=\"line\"><span style=\"color: #A6ACCD\">Content-Length: 271 <\/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\">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\">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\">&gt;<\/span><\/span>\n<span class=\"line\"><span style=\"color: #A6ACCD\">   <\/span><span style=\"color: #89DDFF\">&lt;<\/span><span style=\"color: #F07178\">ErrorMessage<\/span><span style=\"color: #89DDFF\">&gt;<\/span><\/span>\n<span class=\"line\"><span style=\"color: #A6ACCD\">     <\/span><span style=\"color: #89DDFF\">&lt;<\/span><span style=\"color: #F07178\">Code<\/span><span style=\"color: #89DDFF\">&gt;<\/span><span style=\"color: #A6ACCD\">400<\/span><span style=\"color: #89DDFF\">&lt;\/<\/span><span style=\"color: #F07178\">Code<\/span><span style=\"color: #89DDFF\">&gt;<\/span><\/span>\n<span class=\"line\"><span style=\"color: #A6ACCD\">     <\/span><span style=\"color: #89DDFF\">&lt;<\/span><span style=\"color: #F07178\">Message<\/span><span style=\"color: #89DDFF\">&gt;<\/span><span style=\"color: #A6ACCD\">Entry is not a valid SHA256.<\/span><span style=\"color: #89DDFF\">&lt;\/<\/span><span style=\"color: #F07178\">Message<\/span><span style=\"color: #89DDFF\">&gt;<\/span><\/span>\n<span class=\"line\"><span style=\"color: #A6ACCD\">   <\/span><span style=\"color: #89DDFF\">&lt;\/<\/span><span style=\"color: #F07178\">ErrorMessage<\/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":5,"featured_media":0,"parent":3763,"menu_order":260,"template":"","format":"standard","emp-category":[],"class_list":["post-3765","es","type-es","status-publish","format-standard","hentry"],"acf":[],"_links":{"self":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3765","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\/5"}],"version-history":[{"count":3,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3765\/revisions"}],"predecessor-version":[{"id":11026,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3765\/revisions\/11026"}],"up":[{"embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3763"}],"wp:attachment":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/media?parent=3765"}],"wp:term":[{"taxonomy":"emp-category","embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/emp-category?post=3765"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}