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

PutDeliverabilityDashboardOption

Enable or disable the Deliverability dashboard for your Amazon Pinpoint account. When you enable the Deliverability dashboard, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email using Amazon Pinpoint. You also gain the ability to perform predictive inbox placement tests.

When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon Pinpoint. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.

Request Syntax

PUT /v1/email/deliverability-dashboard HTTP/1.1 Content-type: application/json { "DashboardEnabled": boolean, "SubscribedDomains": [ { "Domain": "string", "InboxPlacementTrackingOption": { "Global": boolean, "TrackedIsps": [ "string" ] }, "SubscriptionStartDate": number } ] }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

DashboardEnabled

Specifies whether to enable the Deliverability dashboard for your Amazon Pinpoint account. To enable the dashboard, set this value to true.

Type: Boolean

Required: Yes

SubscribedDomains

An array of objects, one for each verified domain that you use to send email and enabled the Deliverability dashboard for.

Type: Array of DomainDeliverabilityTrackingOption objects

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.

AlreadyExistsException

The resource specified in your request already exists.

HTTP Status Code: 400

BadRequestException

The input you provided is invalid.

HTTP Status Code: 400

LimitExceededException

There are too many instances of the specified resource type.

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: