Delete from suppression list
Used to delete a single entry from suppression list specified by ID parameter. Successful request returns “204 – No content” HTTP code and empty response body.
Request URL parameters:
Element/attribute | Type | Notes |
---|---|---|
apiKey | string | Your API key, required for authentication. Required. |
ID | integer | Suppression list ID. Required as a part of address (not GET parameter). See example below. |
entry | string | Entry to delete from specified suppression list. Required. A valid entry can be: email, e.g. username@domain.com domain, e.g. domain.com MD5, e.g. 2c2ba4dc950fd1162c47b08fdcfabe24 SHA256, e.g. 000243c96f3d54cbcff3b2e234923033b23f3b0a6f9275a9c5e9300d415cc646 phone number, e.g. 48501222333 dialing prefix, e.g. 77 |
entryType | string | Specifies whether the entry to be deleted from a Phone type suppression list is a phone number or dialing prefix. This parameter will be ignored when provided for Email type suppression list). Valid values: phone prefix Optional. Defaults to phone. |
Note: This method will ignore not found values. You will not receive an error when trying to delete an entry that is not present on suppression list.
You will receive an error when sending an invalid or empty entry, though.
Example URLs:
https://api.esv2.com/v2/Api/SuppressionLists/123?apiKey=YOUR_API_KEY_HERE&entry=username%40domain.com
https://api.esv2.com/v2/Api/SuppressionLists/123?apiKey=YOUR_API_KEY_HERE&entry=2c2ba4dc950fd1162c47b08fdcfabe24
Examples
Request:
DELETE https://api.esv2.com/v2/Api/SuppressionLists/123?apiKey=test_api_key1&entry=test%40wwwfwf.pl HTTP/1.1
Accept-Encoding: gzip,deflate
User-Agent: Jakarta Commons-HttpClient/3.1
Host: api.esv2.com
OK response:
HTTP/1.1 204 No Content
Cache-Control: private
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 2.0.50727
Set-Cookie: TIMEZONE=Central European Standard Time; path=/
X-Powered-By: ASP.NET
Date: Wed, 19 Oct 2011 12:15:04 GMT