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

PutSuppressedDestination

Adds an email address to 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 address is added to the account-level suppression list.

Request Syntax


PUT /v2/email/suppression/addresses HTTP/1.1
Content-type: application/json

{
   "EmailAddress": "string",
   "Reason": "string",
   "TenantName": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

EmailAddress

The email address that should be added to the suppression list for your account or for the specified tenant.

Type: String

Required: Yes

Reason

The factors that should cause the email address to be added to the suppression list for your account or for the specified tenant.

Type: String

Valid Values: BOUNCE | COMPLAINT

Required: Yes

TenantName

The name of the tenant whose suppression list you want to add the address to. If you omit this parameter, the address is added to the account-level suppression list.

Type: String

Length Constraints: Minimum length of 1.

Required: No

Response Syntax


HTTP/1.1 200

Response Elements

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

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