Suppressions (API)

Manage and update your Suppression list using the API.11

REST Methods

Note: API is case sensitive. Make all parameters entries lower case. All parameters in red are required.

Note: Write actions (POST, UPDATE, DELETE) may take several minutes to propagate and be reflected by the API. If a subsequent read request fails to reflect your changes, please wait a few minutes and try again.

VERB RESOURCE PARAMETERS DESCRIPTION
GET /suppressions
  • apikey
  • startdate
  • enddate
  • startindex
 Returns a list of suppressed email addresses for the specified account, filtered by date range.
GET /suppressions/count
  • apikey
  • startdate
  • enddate
 Returns the total number of email addresses in the suppression list for the specified account, filtered by date range.
POST /suppressions
  • apikey
  • emailaddress
 Adds one or more recipients to the user’s suppression list. This has the effect of preventing any email from being sent to the recipient in the future.
POST /suppressions/activate
  • apikey
  • emailaddress
 Removes one or more recipients from the user’s suppression list.

 

GET /suppressions

Returns a list of suppressed email addresses for the specified account, filtered by date range.

Parameters

    • apikey — Required. API key of the account with desired information.
    • startdate — Start date/time range in full, ISO 8601 format.
    • enddate End date/time range in full, ISO 8601 format.
    • startindex — Starting index value.
        Valid values:
        Positive whole integers, usually in 500 count increments.
      Example: 501, 1001, etc.

Example Request

curl --request GET "https://emailapi.dynect.net/rest/json/suppressions?apikey=ABC123XYZ"

Example Results (JSON)

{"response":{"status":200,"message":"OK","data":{"suppressions":[{"emailaddress":"email@domain.org","suppresstime":"2011-05-27T08:50:12+01:00","suppressionid":"913839"},...]}}

GET /suppressions/count

Returns the total number of email addresses in the suppression list for the specified account, filtered by date range.

Parameters

  • apikey — Required. API key of the account with desired information.
  • startdate — Start date/time range in full, ISO 8601 format.
  • enddate — End date/time range in full, ISO 8601 format.

Example Request

curl --request GET "https://emailapi.dynect.net/rest/json/suppressions/count?apikey=ABC123XYZ"

Example Results (JSON)

{"response":{"status":200,"message":"OK","data":{"count":"708"}}}

POST /suppressions

Adds one or more recipients to the user’s suppression list. This has the effect of preventing any email from being sent to the recipient in the future.

Parameters

  • apikey — Required. API key of the account where suppressed address(es) are to be added.
  • emailaddress — Required. Email address of recipient to suppress; for multiple addresses, specify a comma-delimited list of email addresses.

Example Request

curl --request POST "https://emailapi.dynect.net/rest/json/suppressions" --data "apikey=ABC123XYZ&emailaddress=example@example.com"

Example Results (JSON)

{"response":{"status":200,"message":"OK","data":{}}}

POST /suppressions/activate

Removes one or more recipients from the user’s suppression list. This will allow you to send email to the recipient’s email address again.

  • apikey — Required. API key of the account where suppressed address(es) are to be added.
  • emailaddress — Required. Email address of recipient to suppress; for multiple addresses, specify a comma-delimited list of email addresses.

Example Request

curl --request POST "https://emailapi.dynect.net/rest/json/suppressions/activate" --data "apikey=ABC123XYZ&emailaddress=example@example.com"

Example Results (JSON)

{"response":{"status":200,"message":"OK","data":[]}}