v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1442212198.5 KB

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

put/v1/email/configuration-sets/{ConfigurationSetName}/tracking-options

Path parameters

ConfigurationSetNamestring required
<p>The name of a configuration set.</p> <p>In Amazon Pinpoint, <i>configuration sets</i> are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.</p>

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

Request body

CustomRedirectDomainstring

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

Response

Success

PutConfigurationSetTrackingOptionsResponse required

An HTTP 200 response if the request succeeds, or an error message if the request fails.