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

StartOutboundEmailContact

Initiates a flow to send an agent reply or outbound email contact (created from the CreateContact API) to a customer.

Request Syntax


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

{
   "AdditionalRecipients": { 
      "CcEmailAddresses": [ 
         { 
            "DisplayName": "string",
            "EmailAddress": "string"
         }
      ]
   },
   "ClientToken": "string",
   "ContactId": "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"
   },
   "InstanceId": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

AdditionalRecipients

The addtional recipients address of 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

ContactId

The identifier of the contact in this instance of Amazon Connect.

Type: String

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

Required: Yes

DestinationEmailAddress

The email address of the customer.

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 associated with the instance.

Type: EmailAddressInfo object

Required: No

InstanceId

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

Type: String

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

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "ContactId": "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.

ContactId

The identifier of the contact in this instance of Amazon Connect.

Type: String

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

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