Amazon Pinpoint Email Service
API Reference (API Version 2018-07-26)

PutConfigurationSetTrackingOptions

Specify a custom domain to use for open and click tracking elements in email that you send using Amazon Pinpoint.

Request Syntax

PUT /v1/email/configuration-sets/ConfigurationSetName/tracking-options HTTP/1.1 Content-type: application/json { "CustomRedirectDomain": "string" }

URI Request Parameters

The request requires the following URI parameters.

ConfigurationSetName

The name of the configuration set that you want to add a custom tracking domain to.

Request Body

The request accepts the following data in JSON format.

CustomRedirectDomain

The domain that you want to use to track open and click events.

Type: String

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: