PUT

/v1/email/configuration-sets/{ConfigurationSetName}/event-destinations/{EventDestinationName}

http://email.{region}.amazonaws.com/v1/email/configuration-sets/{ConfigurationSetName}/event-destinations/{EventDestinationName}

Update the configuration of an event destination for a configuration set. In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.

Access Token Required: API Key

Path Parameters

ConfigurationSetNamestringrequired

The name of the configuration set that contains the event destination that you want to modify.

EventDestinationNamestringrequired

The name of the event destination that you want to modify.

Body Params

EventDestinationobjectrequired

An object that defines the event destination. Specifically, it defines which services receive events from emails sent using the configuration set that the event destination is associated with. Also defines the types of events that are sent to the event destination.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request PUT \
2     --url 'http://email.{region}.amazonaws.com/v1/email/configuration-sets/{ConfigurationSetName}/event-destinations/{EventDestinationName}' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

PUT