PutEmailIdentityFeedbackAttributes - Amazon Pinpoint Email Service

PutEmailIdentityFeedbackAttributes

Used to enable or disable feedback forwarding for an identity. This setting determines what happens when an identity is used to send an email that results in a bounce or complaint event.

When you enable feedback forwarding, Amazon Pinpoint sends you email notifications when bounce or complaint events occur. Amazon Pinpoint sends this notification to the address that you specified in the Return-Path header of the original email.

When you disable feedback forwarding, Amazon Pinpoint sends notifications through other mechanisms, such as by notifying an Amazon SNS topic. You're required to have a method of tracking bounces and complaints. If you haven't set up another mechanism for receiving bounce or complaint notifications, Amazon Pinpoint sends an email notification when these events occur (even if this setting is disabled).

Request Syntax

PUT /v1/email/identities/EmailIdentity/feedback HTTP/1.1 Content-type: application/json { "EmailForwardingEnabled": boolean }

URI Request Parameters

The request uses the following URI parameters.

EmailIdentity

The email identity that you want to configure bounce and complaint feedback forwarding for.

Required: Yes

Request Body

The request accepts the following data in JSON format.

EmailForwardingEnabled

Sets the feedback forwarding configuration for the identity.

If the value is true, Amazon Pinpoint sends you email notifications when bounce or complaint events occur. Amazon Pinpoint sends this notification to the address that you specified in the Return-Path header of the original email.

When you set this value to false, Amazon Pinpoint sends notifications through other mechanisms, such as by notifying an Amazon SNS topic or another event destination. You're required to have a method of tracking bounces and complaints. If you haven't set up another mechanism for receiving bounce or complaint notifications, Amazon Pinpoint sends an email notification when these events occur (even if this setting is disabled).

Type: Boolean

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 Errors.

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: