{"id":3652,"date":"2023-08-30T07:33:00","date_gmt":"2023-08-30T06:33:00","guid":{"rendered":"https:\/\/help.expertsender.com\/?post_type=es&#038;p=3652"},"modified":"2024-06-24T13:36:40","modified_gmt":"2024-06-24T12:36:40","slug":"add-to-suppression-list","status":"publish","type":"es","link":"https:\/\/help.expertsender.com\/pl\/emp\/api\/methods\/suppression-lists\/add-to-suppression-list\/","title":{"rendered":"Add to suppression list"},"content":{"rendered":"\n<p>Used to add a single entry to a suppression list specified by ID parameter. Successful request returns \u201c201 \u2013 Created\u201d HTTP code and empty response body.<\/p>\n\n\n\n<p>Request URL parameters:<\/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>ID<\/td><td>int<\/td><td>Suppression list ID. Required as a part of address (not GET parameter). See example below.<\/td><\/tr><tr><td>entry<\/td><td>string<\/td><td>Entry to add to specified suppression 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. 000243c96f3d54cbcff3b2e234923033b23f3b0a6f9275a9c5e9300d415cc646<br>phone,e.g. 48501202365<br>dialing prefix, e.g. 48<br>Required.<\/td><\/tr><tr><td>entryType&nbsp;<\/td><td>string<\/td><td>Specifies whether the entry to be added to a Phone-type suppression list is a phone number of dialing prefix (this parameter will be ignored when provided for Email-type suppression list). Valid values:<br>phone<br>prefix<br>Optional. Defaults to phone. \u00a0<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<p>This method will ignore duplicated values on suppression list. You will not receive an error when trying to add an email address (or domain, MD5, phone, prefix) that is already present on suppression list.<\/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:0.015625px;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\/SuppressionLists\/123?apiKey=YOUR_API_KEY_HERE&amp;entry=username%40domain.com \nhttps:\/\/api.esv2.com\/v2\/Api\/SuppressionLists\/123?apiKey=YOUR_API_KEY_HERE&amp;entry=2c2ba4dc950fd1162c47b08fdcfabe24\nhttps:\/\/api.esv2.com\/v2\/Api\/SuppressionLists\/456?apiKey=YOUR_API_KEY_HERE&amp;entryType=prefix&amp;entry=48\" 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\/SuppressionLists\/123?apiKey=YOUR_API_KEY_HERE&amp;entry=username%40domain.com <\/span><\/span>\n<span class=\"line\"><\/span>\n<span class=\"line\"><span style=\"color: #A6ACCD\">https:\/\/api.esv2.com\/v2\/Api\/SuppressionLists\/123?apiKey=YOUR_API_KEY_HERE&amp;entry=2c2ba4dc950fd1162c47b08fdcfabe24<\/span><\/span>\n<span class=\"line\"><\/span>\n<span class=\"line\"><span style=\"color: #A6ACCD\">https:\/\/api.esv2.com\/v2\/Api\/SuppressionLists\/456?apiKey=YOUR_API_KEY_HERE&amp;entryType=prefix&amp;entry=48<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"h.w0l5bcgq1qq2_l\"><strong>Examples<\/strong><\/h3>\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:#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\/SuppressionLists\/123?apiKey=test_api_key1&amp;entry=username40domain.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\/SuppressionLists\/123?apiKey=test_api_key1&amp;entry=username40domain.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:<\/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 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:#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 email, domain or MD5.&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 email, domain or MD5.<\/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":3645,"menu_order":301,"template":"","format":"standard","emp-category":[],"class_list":["post-3652","es","type-es","status-publish","format-standard","hentry"],"acf":[],"_links":{"self":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3652","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\/3652\/revisions"}],"predecessor-version":[{"id":10840,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3652\/revisions\/10840"}],"up":[{"embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3645"}],"wp:attachment":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/media?parent=3652"}],"wp:term":[{"taxonomy":"emp-category","embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/emp-category?post=3652"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}