Skip to content

Get suppression lists

Lists collection allows retrieving all active suppression lists defined in the system.

Request data format

Request URL parameters:

Element/attributeTypeNotes
apiKeystringYour API key, required for authentication. Required.

Examples:

https://api.esv2.com/v2/Api/SuppressionLists?apiKey=YOUR_API_KEY_HERE

Response

Response Data element:

Element/attributeTypeNotes
SuppressionListsarray[complex]Array of SuppressionList elements.

SuppressionList element children:

Element/attributeTypeNotes
IdintSuppression list identifier.
NamestringSuppression list name.
ListTypestringA suppression list type. Possible values:
EmailSmsMms
ImportRulestringImport rule only for ‘Email’ list type. Possible values:
OnlyEmailEmailAndDomain

Examples

Request:

GET https://api.esv2.com/v2/Api/SuppressionLists?apiKey=test_api_key1 HTTP/1.1
Accept-Encoding: gzip,deflate
Host: api.esv2.com
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)

OK response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: text/xml; charset=utf-8
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 3.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Wed, 21 Feb 2018 13:35:54 GMT
Content-Length: 320

<ApiResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Data>
    <SuppressionLists>
      <SuppressionList>
        <Id>1</Id>
        <Name>clients</Name>
        <ListType>Email</ListType>
        <ImportRule>EmailAndDomain</ImportRule>
      </SuppressionList>
      <SuppressionList>
        <Id>2</Id>
        <Name>friends</Name>
        <ListType>SmsMms</ListType>
      </SuppressionList>
    </SuppressionLists>
  </Data>
</ApiResponse>
On this page
To top