Overview

This request lists all transactional suppressions, the origin of the suppression, as well as a description of the suppression, if one was provided. The suppression origin can be one of bounce, user or unsubscribe. User suppressions refer to suppressions that have been added to the suppression list via API.

Endpoint

Method URL
GET https://api.everlytic.net/transactional/email/v1/suppression/

Response

Status codes

Status code Explanation
200 Ok Webhook was created successfully
401 Unauthorized The provided authorization credentials are incorrect

Properties

Property Description Data type Parameters
suppressed_emails Array containing the details of all email addresses that have been suppressed Array
email The email address that has been suppressed string
origin The source for the suppression, whether instigated by a user, bounce, or unsubscribe string
  • user
  • bounce
  • unsubscribe
description Text description of the reason for suppression string|null
suppressed_timestamp Date and time that the email address was suppressed date-time ISO 8601 date-time string

Properties of responses with 4XX status

Property Description Data type Expected parameters
code The HTTP response status code integer
  • 401
message The reason for the failure string Valid string
error Array containing errors field JSON
  • errors
errors Array containing the failure details JSON
  • domain
  • reason
  • message
  • locationType
  • location
domain The classification of the type of error string
  • global
reason Keyword used to describe the error string
  • required
message Text describing the reason for the failure string Valid string
locationType The location where the failure occurred string
  • request
location The type of validation that failed string
  • authorization

Example responses

Response with suppressed emails [200 OK]

{
  "suppressed_emails": [
    {
      "email": "[email protected]",
      "origin": "user",
      "description": null,
      "suppressed_timestamp": "2023-08-16T14:47:55.000Z"
    },
    {
      "email": "[email protected]",
      "origin": "user",
      "description": null,
      "suppressed_timestamp": "2023-08-16T14:47:55.000Z"
    },
    {
      "email": "[email protected]",
      "origin": "user",
      "description": null,
      "suppressed_timestamp": "2023-08-16T14:47:55.000Z"
    },
    {
      "email": "[email protected]",
      "origin": "user",
      "description": null,
      "suppressed_timestamp": "2023-08-16T14:47:55.000Z"
    }
  ]
}

Response with suppressed emails [200 OK]

{
  "suppressed_emails": []
}

Invalid/Missing authorization credentials [401 Unauthorized]

{
    "code": 401,
    "message": "Login Required",
    "error": {
        "errors": [
            {
                "domain": "global",
                "reason": "required",
                "message": "Login Required",
                "locationType": "request",
                "location": "authorization"
            }
        ]
    }
}