Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1442212198.5 KB

Create a new predictive inbox placement test. Predictive inbox placement tests can help you predict how your messages will be handled by various email providers around the world. When you perform a predictive inbox placement test, you provide a sample message that contains the content that you plan to send to your customers. Amazon Pinpoint then sends that message to special email addresses spread across several major email providers. After about 24 hours, the test is complete, and you can use the <code>GetDeliverabilityTestReport</code> operation to view the results of the test.

post/v1/email/deliverability-dashboard/test

Request body

ReportNamestring

A name that helps you identify a report generated by the Deliverability dashboard.

FromEmailAddressstring required

The email address that the predictive inbox placement test email was sent from.

Response

Success

ReportIdstring required

A unique string that identifies the predictive inbox placement test.

DeliverabilityTestStatus'IN_PROGRESS' | 'COMPLETED' required

The status of the predictive inbox placement test. If the status is <code>IN_PROGRESS</code>, then the predictive inbox placement test is currently running. Predictive inbox placement tests are usually complete within 24 hours of creating the test. If the status is <code>COMPLETE</code>, then the test is finished, and you can use the <code>GetDeliverabilityTestReport</code> to view the results of the test.