SendOutboundEmail - Amazon Connect
Request SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsSee Also

SendOutboundEmail

Send outbound email for outbound campaigns. For more information about outbound campaigns, see Set up Amazon Connect outbound campaigns.

Note

Only the Amazon Connect outbound campaigns service principal is allowed to assume a role in your account and call this API.

Request Syntax

PUT /instance/InstanceId/outbound-email HTTP/1.1
Content-type: application/json

{
   "AdditionalRecipients": { 
      "CcEmailAddresses": [ 
         { 
            "DisplayName": "string",
            "EmailAddress": "string"
         }
      ]
   },
   "ClientToken": "string",
   "DestinationEmailAddress": { 
      "DisplayName": "string",
      "EmailAddress": "string"
   },
   "EmailMessage": { 
      "MessageSourceType": "string",
      "RawMessage": { 
         "Body": "string",
         "ContentType": "string",
         "Subject": "string"
      },
      "TemplatedMessageConfig": { 
         "KnowledgeBaseId": "string",
         "MessageTemplateId": "string",
         "TemplateAttributes": { 
            "CustomAttributes": { 
               "string" : "string" 
            },
            "CustomerProfileAttributes": "string"
         }
      }
   },
   "FromEmailAddress": { 
      "DisplayName": "string",
      "EmailAddress": "string"
   },
   "SourceCampaign": { 
      "CampaignId": "string",
      "OutboundRequestId": "string"
   },
   "TrafficType": "string"
}

URI Request Parameters

The request uses the following URI parameters.

InstanceId

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: Yes

Request Body

The request accepts the following data in JSON format.

AdditionalRecipients

The additional recipients address of the email in CC.

Type: OutboundAdditionalRecipients object

Required: No

ClientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

Type: String

Length Constraints: Maximum length of 500.

Required: No

DestinationEmailAddress

The email address to send the email to.

Type: EmailAddressInfo object

Required: Yes

EmailMessage

The email message body to be sent to the newly created email.

Type: OutboundEmailContent object

Required: Yes

FromEmailAddress

The email address to be used for sending email.

Type: EmailAddressInfo object

Required: Yes

SourceCampaign

A Campaign object need for Campaign traffic type.

Type: SourceCampaign object

Required: No

TrafficType

Denotes the class of traffic.

Type: String

Valid Values: GENERAL | CAMPAIGN

Required: Yes

Response Syntax

HTTP/1.1 200

Response Elements

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

Errors

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

AccessDeniedException

You do not have sufficient permissions to perform this action.

HTTP Status Code: 403

IdempotencyException

An entity with the same name already exists.

HTTP Status Code: 409

InternalServiceException

Request processing failed because of an error or failure with the service.

HTTP Status Code: 500

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 404

ServiceQuotaExceededException

The service quota has been exceeded.

HTTP Status Code: 402

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: