Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateEmailIdentity

Verifies an email identity for use with Amazon Pinpoint. In Amazon Pinpoint, an identity is an email address or domain that you use when you send email. Before you can use an identity to send email with Amazon Pinpoint, you first have to verify it. By verifying an address, you demonstrate that you're the owner of the address, and that you've given Amazon Pinpoint permission to send email from the address.

When you verify an email address, Amazon Pinpoint sends an email to the address. Your email address is verified as soon as you follow the link in the verification email.

When you verify a domain, this operation provides a set of DKIM tokens, which you can convert into CNAME tokens. You add these CNAME tokens to the DNS configuration for your domain. Your domain is verified when Amazon Pinpoint detects these records in the DNS configuration for your domain. It usually takes around 72 hours to complete the domain verification process.

Request Syntax


POST /v1/email/identities HTTP/1.1
Content-type: application/json

{
   "EmailIdentity": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

EmailIdentity

The email address or domain that you want to verify.

Type: String

Required: Yes

Tags

An array of objects that define the tags (keys and values) that you want to associate with the email identity.

Type: Array of Tag objects

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "DkimAttributes": { 
      "SigningEnabled": boolean,
      "Status": "string",
      "Tokens": [ "string" ]
   },
   "IdentityType": "string",
   "VerifiedForSendingStatus": boolean
}

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.

DkimAttributes

An object that contains information about the DKIM attributes for the identity. This object includes the tokens that you use to create the CNAME records that are required to complete the DKIM verification process.

Type: DkimAttributes object

IdentityType

The email identity type.

Type: String

Valid Values: EMAIL_ADDRESS | DOMAIN | MANAGED_DOMAIN

VerifiedForSendingStatus

Specifies whether or not the identity is verified. In Amazon Pinpoint, you can only send email from verified email addresses or domains. For more information about verifying identities, see the Amazon Pinpoint User Guide.

Type: Boolean

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

ConcurrentModificationException

The resource is being modified by another operation or thread.

HTTP Status Code: 500

LimitExceededException

There are too many instances of the specified resource type.

HTTP Status Code: 400

TooManyRequestsException

Too many requests have been made to the operation.

HTTP Status Code: 429