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

PutConfigurationSetTrackingOptions

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

Request Syntax


PUT /v2/email/configuration-sets/ConfigurationSetName/tracking-options HTTP/1.1
Content-type: application/json

{
   "CustomRedirectDomain": "string",
   "HttpsPolicy": "string"
}

URI Request Parameters

The request uses the following URI parameters.

ConfigurationSetName

The name of the configuration set.

Required: Yes

Request Body

The request accepts the following data in JSON format.

CustomRedirectDomain

The domain to use to track open and click events.

Type: String

Required: No

HttpsPolicy

The https policy to use for tracking open and click events. If the value is OPTIONAL or HttpsPolicy is not specified, the open trackers use HTTP and click tracker use the original protocol of the link. If the value is REQUIRE, both open and click tracker uses HTTPS and if the value is REQUIRE_OPEN_ONLY open tracker uses HTTPS and link tracker is same as original protocol of the link.

Type: String

Valid Values: REQUIRE | REQUIRE_OPEN_ONLY | OPTIONAL

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