PUT

/v2/email/identities/{EmailIdentity}/mail-from

http://email.{region}.amazonaws.com/v2/email/identities/{EmailIdentity}/mail-from

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

Access Token Required: API Key

Path Parameters

EmailIdentitystringrequired

The verified email identity.

Body Params

MailFromDomainstring

The domain to use as a MAIL FROM domain.

BehaviorOnMxFailurestring

The action to take if the required MX record can't be found when you send an email. When you set this value to <code>UseDefaultValue</code>, the mail is sent using amazonses.com as the MAIL FROM domain. When you set this value to <code>RejectMessage</code>, the Amazon SES API v2 returns a <code>MailFromDomainNotVerified</code> error, and doesn't attempt to deliver the email. 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.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request PUT \
2     --url 'http://email.{region}.amazonaws.com/v2/email/identities/{EmailIdentity}/mail-from' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}