SendCustomVerificationEmail - Amazon SES API v2

SendCustomVerificationEmail

Adds an email address to the list of identities for your Amazon SES account in the current AWS Region and attempts to verify it. As a result of executing this operation, a customized verification email is sent to the specified address.

To use this operation, you must first create a custom verification email template. For more information about creating and using custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Request Syntax

POST /v2/email/outbound-custom-verification-emails HTTP/1.1 Content-type: application/json { "ConfigurationSetName": "string", "EmailAddress": "string", "TemplateName": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

ConfigurationSetName

Name of a configuration set to use when sending the verification email.

Type: String

Required: No

EmailAddress

The email address to verify.

Type: String

Required: Yes

TemplateName

The name of the custom verification email template to use when sending the verification email.

Type: String

Length Constraints: Minimum length of 1.

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "MessageId": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

MessageId

The unique message identifier returned from the SendCustomVerificationEmail operation.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

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

MailFromDomainNotVerifiedException

The message can't be sent because the sending domain isn't verified.

HTTP Status Code: 400

MessageRejected

The message can't be sent because it contains invalid content.

HTTP Status Code: 400

NotFoundException

The resource you attempted to access doesn't exist.

HTTP Status Code: 404

SendingPausedException

The message can't be sent because the account's ability to send email is currently paused.

HTTP Status Code: 400

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: