Retrieve a Global Suppression

v1.0.0

This endpoint allows you to retrieve a global suppression. You can also use this endpoint to confirm if an email address is already globally suppresed.

If the email address you include in the URL path parameter {email} is already globally suppressed, the response will include that email address. If the address you enter for {email} is not globally suppressed, an empty JSON object {} will be returned.

Input

{
  "type": "object",
  "properties": {
    "on-behalf-of": {
      "type": "string"
    }
  },
  "additionalProperties": false
}

Output

{
  "type": "object",
  "required": [
    "recipient_email"
  ],
  "properties": {
    "recipient_email": {
      "type": "string",
      "format": "email",
      "description": "The email address that is globally suppressed. This will be an empty object if the email address you included in your call is not globally suppressed."
    }
  }
}