

# StartOutboundEmailContact
<a name="API_StartOutboundEmailContact"></a>

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

## Request Syntax
<a name="API_StartOutboundEmailContact_RequestSyntax"></a>

```
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
<a name="API_StartOutboundEmailContact_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_StartOutboundEmailContact_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [AdditionalRecipients](#API_StartOutboundEmailContact_RequestSyntax) **   <a name="connect-StartOutboundEmailContact-request-AdditionalRecipients"></a>
The additional recipients address of email in CC.  
Type: [OutboundAdditionalRecipients](API_OutboundAdditionalRecipients.md) object  
Required: No

 ** [ClientToken](#API_StartOutboundEmailContact_RequestSyntax) **   <a name="connect-StartOutboundEmailContact-request-ClientToken"></a>
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](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Maximum length of 500.  
Required: No

 ** [ContactId](#API_StartOutboundEmailContact_RequestSyntax) **   <a name="connect-StartOutboundEmailContact-request-ContactId"></a>
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](#API_StartOutboundEmailContact_RequestSyntax) **   <a name="connect-StartOutboundEmailContact-request-DestinationEmailAddress"></a>
The email address of the customer.  
Type: [EmailAddressInfo](API_EmailAddressInfo.md) object  
Required: Yes

 ** [EmailMessage](#API_StartOutboundEmailContact_RequestSyntax) **   <a name="connect-StartOutboundEmailContact-request-EmailMessage"></a>
The email message body to be sent to the newly created email.  
Type: [OutboundEmailContent](API_OutboundEmailContent.md) object  
Required: Yes

 ** [FromEmailAddress](#API_StartOutboundEmailContact_RequestSyntax) **   <a name="connect-StartOutboundEmailContact-request-FromEmailAddress"></a>
The email address associated with the Amazon Connect instance.  
Type: [EmailAddressInfo](API_EmailAddressInfo.md) object  
Required: No

 ** [InstanceId](#API_StartOutboundEmailContact_RequestSyntax) **   <a name="connect-StartOutboundEmailContact-request-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) 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
<a name="API_StartOutboundEmailContact_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ContactId": "string"
}
```

## Response Elements
<a name="API_StartOutboundEmailContact_ResponseElements"></a>

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](#API_StartOutboundEmailContact_ResponseSyntax) **   <a name="connect-StartOutboundEmailContact-response-ContactId"></a>
The identifier of the contact in this instance of Amazon Connect.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.

## Errors
<a name="API_StartOutboundEmailContact_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** 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.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The service quota has been exceeded.    
 ** Reason **   
The reason for the exception.
HTTP Status Code: 402

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_StartOutboundEmailContact_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/StartOutboundEmailContact) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/StartOutboundEmailContact) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/StartOutboundEmailContact) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/StartOutboundEmailContact) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/StartOutboundEmailContact) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/StartOutboundEmailContact) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/StartOutboundEmailContact) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/StartOutboundEmailContact) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/StartOutboundEmailContact) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/StartOutboundEmailContact) 