---
title: "POST /v2/email/deliverability-dashboard/test"
method: POST
path: "/v2/email/deliverability-dashboard/test"
---

# POST /v2/email/deliverability-dashboard/test

`POST /v2/email/deliverability-dashboard/test`

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 SES 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.

## Request body

- object
  - `ReportName` string — A name that helps you identify a report generated by the Deliverability dashboard.
  - `FromEmailAddress` string, required — The email address that the predictive inbox placement test email was sent from.
  - `Content` object, required — An object that defines the entire content of the email, including the message headers and the body content. You can create a simple email message, in which you specify the subject and the text and HTML versions of the message body. You can also create raw messages, in which you specify a complete MIME-formatted message. Raw messages can include attachments and custom headers.
    - `Simple` object — The simple email message. The message consists of a subject and a message body.
      - `Subject` object, required — The subject line of the email. The subject line can only contain 7-bit ASCII characters. However, you can specify non-ASCII characters in the subject line by using encoded-word syntax, as described in <a href="https://tools.ietf.org/html/rfc2047">RFC 2047</a>.
        - `Data` string, required — The content of the message itself.
        - `Charset` string — The character set for the content. Because of the constraints of the SMTP protocol, Amazon SES uses 7-bit ASCII by default. If the text includes characters outside of the ASCII range, you have to specify a character set. For example, you could specify <code>UTF-8</code>, <code>ISO-8859-1</code>, or <code>Shift_JIS</code>.
      - `Body` object, required — The body of the message. You can specify an HTML version of the message, a text-only version of the message, or both.
        - `Text` object — An object that represents the version of the message that is displayed in email clients that don't support HTML, or clients where the recipient has disabled HTML rendering.
          - `Data` string, required — The content of the message itself.
          - `Charset` string — The character set for the content. Because of the constraints of the SMTP protocol, Amazon SES uses 7-bit ASCII by default. If the text includes characters outside of the ASCII range, you have to specify a character set. For example, you could specify <code>UTF-8</code>, <code>ISO-8859-1</code>, or <code>Shift_JIS</code>.
        - `Html` object — An object that represents the version of the message that is displayed in email clients that support HTML. HTML messages can include formatted text, hyperlinks, images, and more.
          - `Data` string, required — The content of the message itself.
          - `Charset` string — The character set for the content. Because of the constraints of the SMTP protocol, Amazon SES uses 7-bit ASCII by default. If the text includes characters outside of the ASCII range, you have to specify a character set. For example, you could specify <code>UTF-8</code>, <code>ISO-8859-1</code>, or <code>Shift_JIS</code>.
    - `Raw` object — <p>The raw email message. The message has to meet the following criteria:</p> <ul> <li> <p>The message has to contain a header and a body, separated by one blank line.</p> </li> <li> <p>All of the required header fields must be present in the message.</p> </li> <li> <p>Each part of a multipart MIME message must be formatted properly.</p> </li> <li> <p>If you include attachments, they must be in a file format that the Amazon SES API v2 supports. </p> </li> <li> <p>The entire message must be Base64 encoded.</p> </li> <li> <p>If any of the MIME parts in your message contain content that is outside of the 7-bit ASCII character range, you should encode that content to ensure that recipients' email clients render the message properly.</p> </li> <li> <p>The length of any single line of text in the message can't exceed 1,000 characters. This restriction is defined in <a href="https://tools.ietf.org/html/rfc5321">RFC 5321</a>.</p> </li> </ul>
      - `Data` string, required — <p>The raw email message. The message has to meet the following criteria:</p> <ul> <li> <p>The message has to contain a header and a body, separated by one blank line.</p> </li> <li> <p>All of the required header fields must be present in the message.</p> </li> <li> <p>Each part of a multipart MIME message must be formatted properly.</p> </li> <li> <p>Attachments must be in a file format that the Amazon SES supports.</p> </li> <li> <p>The entire message must be Base64 encoded.</p> </li> <li> <p>If any of the MIME parts in your message contain content that is outside of the 7-bit ASCII character range, you should encode that content to ensure that recipients' email clients render the message properly.</p> </li> <li> <p>The length of any single line of text in the message can't exceed 1,000 characters. This restriction is defined in <a href="https://tools.ietf.org/html/rfc5321">RFC 5321</a>.</p> </li> </ul>
    - `Template` object — The template to use for the email message.
      - `TemplateName` string — The name of the template. You will refer to this name when you send email using the <code>SendTemplatedEmail</code> or <code>SendBulkTemplatedEmail</code> operations.
      - `TemplateArn` string — The Amazon Resource Name (ARN) of the template.
      - `TemplateData` string — An object that defines the values to use for message variables in the template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the value to use for that variable.
  - `Tags` Tag[] — An array of objects that define the tags (keys and values) that you want to associate with the predictive inbox placement test.
    - `Key` string, required — One part of a key-value pair that defines a tag. The maximum length of a tag key is 128 characters. The minimum length is 1 character.
    - `Value` string, required — The optional part of a key-value pair that defines a tag. The maximum length of a tag value is 256 characters. The minimum length is 0 characters. If you don't want a resource to have a specific tag value, don't specify a value for this parameter. If you don't specify a value, Amazon SES sets the value to an empty string.

## Response `200`

Success

- CreateDeliverabilityTestReportResponse — Information about the predictive inbox placement test that you created.
  - `ReportId` string, 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.

## Other responses

- `480` — AccountSuspendedException
- `481` — SendingPausedException
- `482` — MessageRejected
- `483` — MailFromDomainNotVerifiedException
- `484` — NotFoundException
- `485` — TooManyRequestsException
- `486` — LimitExceededException
- `487` — BadRequestException
- `488` — ConcurrentModificationException

---

[API](https://skmtc.net/aws/apis/sesv2.md) · [All operations](https://skmtc.net/aws/apis/sesv2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/sesv2/versions/25eba06e7f64/schema)