Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetSuppressedDestination

Retrieves information about a specific email address that's on the suppression list for your account or for a specific tenant. To target a tenant's suppression list, specify the TenantName parameter. If you omit TenantName, the operation targets the account-level suppression list.

Request Syntax


GET /v2/email/suppression/addresses/EmailAddress?TenantName=TenantName HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

EmailAddress

The email address that's on the suppression list for your account or for the specified tenant.

Required: Yes

TenantName

The name of the tenant whose suppression list you want to query. If you omit this parameter, the operation targets the account-level suppression list.

Length Constraints: Minimum length of 1.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "SuppressedDestination": { 
      "Attributes": { 
         "FeedbackId": "string",
         "MessageId": "string"
      },
      "EmailAddress": "string",
      "LastUpdateTime": number,
      "Reason": "string",
      "TenantName": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

SuppressedDestination

An object containing information about the suppressed email address.

Type: SuppressedDestination object

Errors

For information about the errors that are common to all actions, see Common Error Types.

BadRequestException

The input you provided is invalid.

HTTP Status Code: 400

NotFoundException

The resource you attempted to access doesn't exist.

HTTP Status Code: 404

TooManyRequestsException

Too many requests have been made to the operation.

HTTP Status Code: 429