v1

latestOpenAPI 3.1.02026-07-24700259.3 KB

SUPPRESSIONS

View suppressions

Returns your suppressed email addresses and domains

post/suppression/view

Request body

continue_tokenstring

If returned from a request this can be passed to continue paging through the result of the results

email_addressstring

If provided, checks if a specific email address or domain is in the block list

end_datestring

ISO-8601 formatted datetime which defaults to 30 days prior to the current date at midnight. Timezone is UTC

fuzzyboolean

Indicates if the search should use fuzzy matching on recipients & reasons

reasonstring

A reason string to search for

reasonsstring[]

An array of reason strings to search for

recipientstring

A recipient string to search for

recipientsstring[]

An array of recipient strings to search for

sortstring

The direction to sort the results, either <code>asc</code> or <code>desc</code>

start_datestring

ISO-8601 formatted datetime which defaults to the current date at midnight. Timezone is UTC

suppression_typestring

If passed restricts the search to a single suppression type <code>manual</code>, <code>spam</code>, <code>unsubscribe</code>, <code>bounce</code> or <code>compliance</code>

suppression_typesstring[]

If passed restricts the search to multiple suppression types <code>manual</code>, <code>spam</code>, <code>unsubscribe</code>, <code>bounce</code> or <code>compliance</code>

wildcardstring

If provided, only suppressions with this wildcard string in name, domain, or email address fields, will be returned

subaccount_idstring

If you wish to make this API call on behalf of a subaccount then include its unique ID here

Response

List of suppressions

request_idstring required

Example response

{
  "request_id": "e61431d0-a532-11e8-a307-f23c91285f72",
  "data": {
    "results": [
      {
        "reason": "manual",
        "block_description": "no longer a customer",
        "timestamp": "2018-08-21 11:10:55.457489+00:00",
        "email_address": "test@example.com"
      }
    ]
  }
}