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

SendBulkEmail

Composes an email message to multiple destinations.

Request Syntax


POST /v2/email/outbound-bulk-emails HTTP/1.1
Content-type: application/json

{
   "BulkEmailEntries": [ 
      { 
         "Destination": { 
            "BccAddresses": [ "string" ],
            "CcAddresses": [ "string" ],
            "ToAddresses": [ "string" ]
         },
         "ReplacementEmailContent": { 
            "ReplacementTemplate": { 
               "ReplacementTemplateData": "string"
            }
         },
         "ReplacementHeaders": [ 
            { 
               "Name": "string",
               "Value": "string"
            }
         ],
         "ReplacementTags": [ 
            { 
               "Name": "string",
               "Value": "string"
            }
         ]
      }
   ],
   "ConfigurationSetName": "string",
   "DefaultContent": { 
      "Template": { 
         "Headers": [ 
            { 
               "Name": "string",
               "Value": "string"
            }
         ],
         "TemplateArn": "string",
         "TemplateContent": { 
            "Html": "string",
            "Subject": "string",
            "Text": "string"
         },
         "TemplateData": "string",
         "TemplateName": "string"
      }
   },
   "DefaultEmailTags": [ 
      { 
         "Name": "string",
         "Value": "string"
      }
   ],
   "EndpointId": "string",
   "FeedbackForwardingEmailAddress": "string",
   "FeedbackForwardingEmailAddressIdentityArn": "string",
   "FromEmailAddress": "string",
   "FromEmailAddressIdentityArn": "string",
   "ReplyToAddresses": [ "string" ]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

BulkEmailEntries

The list of bulk email entry objects.

Type: Array of BulkEmailEntry objects

Required: Yes

ConfigurationSetName

The name of the configuration set to use when sending the email.

Type: String

Required: No

DefaultContent

An object that contains the body of the message. You can specify a template message.

Type: BulkEmailContent object

Required: Yes

DefaultEmailTags

A list of tags, in the form of name/value pairs, to apply to an email that you send using the SendEmail operation. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.

Type: Array of MessageTag objects

Required: No

EndpointId

The ID of the multi-region endpoint (global-endpoint).

Type: String

Required: No

FeedbackForwardingEmailAddress

The address that you want bounce and complaint notifications to be sent to.

Type: String

Required: No

FeedbackForwardingEmailAddressIdentityArn

This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the FeedbackForwardingEmailAddress parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedback@example.com, then you would specify the FeedbackForwardingEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FeedbackForwardingEmailAddress to be feedback@example.com.

For more information about sending authorization, see the Amazon SES Developer Guide.

Type: String

Required: No

FromEmailAddress

The email address to use as the "From" address for the email. The address that you specify has to be verified.

Type: String

Required: No

FromEmailAddressIdentityArn

For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use sender@example.com, then you would specify the FromEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FromEmailAddress to be sender@example.com.

For more information about sending authorization, see the Amazon SES Developer Guide.

Type: String

Required: No

ReplyToAddresses

The "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.

Type: Array of strings

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "BulkEmailEntryResults": [ 
      { 
         "Error": "string",
         "MessageId": "string",
         "Status": "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.

BulkEmailEntryResults

One object per intended recipient. Check each response object and retry any messages with a failure status.

Type: Array of BulkEmailEntryResult objects

Errors

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

AccountSuspendedException

The message can't be sent because the account's ability to send email has been permanently restricted.

HTTP Status Code: 400

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