Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1442212198.5 KB

Used to enable or disable the custom Mail-From domain configuration for an email identity.

put/v1/email/identities/{EmailIdentity}/mail-from

Path parameters

EmailIdentitystring required

The verified email identity that you want to set up the custom MAIL FROM domain for.

Request body

MailFromDomainstring

The domain that you want to use as a MAIL FROM domain.

BehaviorOnMxFailure'USE_DEFAULT_VALUE' | 'REJECT_MESSAGE'
<p>The action that you want Amazon Pinpoint to take if it can't read the required MX record for a custom MAIL FROM domain. When you set this value to <code>UseDefaultValue</code>, Amazon Pinpoint uses <i>amazonses.com</i> as the MAIL FROM domain. When you set this value to <code>RejectMessage</code>, Amazon Pinpoint returns a <code>MailFromDomainNotVerified</code> error, and doesn't attempt to deliver the email.</p> <p>These behaviors are taken when the custom MAIL FROM domain configuration is in the <code>Pending</code>, <code>Failed</code>, and <code>TemporaryFailure</code> states.</p>

Response

Success

PutEmailIdentityMailFromAttributesResponse required

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