POST

/v2/email/outbound-bulk-emails

http://email.{region}.amazonaws.com/v2/email/outbound-bulk-emails

Composes an email message to multiple destinations.

Access Token Required: API Key

Body Params

DefaultContentobjectrequired

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

BulkEmailEntriesarrayrequired

A list of <code>BulkEmailEntry</code> objects.

DefaultEmailTagsarray

A list of message tags.

FromEmailAddressstring

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

ReplyToAddressesarray

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

ConfigurationSetNamestring

The name of a configuration set. Configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.

FromEmailAddressIdentityArnstring

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 <code>FromEmailAddress</code> 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 sender@example.com, then you would specify the <code>FromEmailAddressIdentityArn</code> to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the <code>FromEmailAddress</code> to be sender@example.com. For more information about sending authorization, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer Guide</a>.

FeedbackForwardingEmailAddressstring

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

FeedbackForwardingEmailAddressIdentityArnstring

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 <code>FeedbackForwardingEmailAddress</code> 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 <code>FeedbackForwardingEmailAddressIdentityArn</code> to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the <code>FeedbackForwardingEmailAddress</code> to be feedback@example.com. For more information about sending authorization, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer Guide</a>.

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 POST \
2     --url 'http://email.{region}.amazonaws.com/v2/email/outbound-bulk-emails' \
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}

POST

/v2/email/outbound-bulk-emails

http://email.{region}.amazonaws.com/v2/email/outbound-bulk-emails

Composes an email message to multiple destinations.

Access Token Required: API Key

Body Params

DefaultContentobjectrequired

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

BulkEmailEntriesarrayrequired

A list of <code>BulkEmailEntry</code> objects.

DefaultEmailTagsarray

A list of message tags.

FromEmailAddressstring

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

ReplyToAddressesarray

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

ConfigurationSetNamestring

FromEmailAddressIdentityArnstring

FeedbackForwardingEmailAddressstring

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

FeedbackForwardingEmailAddressIdentityArnstring

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 <code>FeedbackForwardingEmailAddress</code> 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 <code>FeedbackForwardingEmailAddressIdentityArn</code> to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the <code>FeedbackForwardingEmailAddress</code> to be feedback@example.com. For more information about sending authorization, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer Guide</a>.

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 POST \
2     --url 'http://email.{region}.amazonaws.com/v2/email/outbound-bulk-emails' \
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}