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

StartEmailContact

Creates an inbound email contact and initiates a flow to start the email contact for the customer. Response of this API provides the ContactId of the email contact created.

Request Syntax


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

{
   "AdditionalRecipients": { 
      "CcAddresses": [ 
         { 
            "DisplayName": "string",
            "EmailAddress": "string"
         }
      ],
      "ToAddresses": [ 
         { 
            "DisplayName": "string",
            "EmailAddress": "string"
         }
      ]
   },
   "Attachments": [ 
      { 
         "FileName": "string",
         "S3Url": "string"
      }
   ],
   "Attributes": { 
      "string" : "string" 
   },
   "ClientToken": "string",
   "ContactFlowId": "string",
   "Description": "string",
   "DestinationEmailAddress": "string",
   "EmailMessage": { 
      "MessageSourceType": "string",
      "RawMessage": { 
         "Body": "string",
         "ContentType": "string",
         "Headers": { 
            "string" : "string" 
         },
         "Subject": "string"
      }
   },
   "FromEmailAddress": { 
      "DisplayName": "string",
      "EmailAddress": "string"
   },
   "InstanceId": "string",
   "Name": "string",
   "References": { 
      "string" : { 
         "Arn": "string",
         "Status": "string",
         "StatusReason": "string",
         "Type": "string",
         "Value": "string"
      }
   },
   "RelatedContactId": "string",
   "SegmentAttributes": { 
      "string" : { 
         "ValueString": "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 the email.

Type: InboundAdditionalRecipients object

Required: No

Attachments

List of S3 presigned URLs of email attachments and their file name.

Type: Array of EmailAttachment objects

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Required: No

Attributes

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

Type: String to string map

Key Length Constraints: Minimum length of 1. Maximum length of 32767.

Value Length Constraints: Minimum length of 0. Maximum length of 32767.

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

ContactFlowId

The identifier of the flow for initiating the emails. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to Routing, Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx

Type: String

Length Constraints: Maximum length of 500.

Required: No

Description

A description of the email contact.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 4096.

Required: No

DestinationEmailAddress

The email address associated with the instance.

Type: String

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

Pattern: [^\s@]+@[^\s@]+\.[^\s@]+

Required: Yes

EmailMessage

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

Type: InboundEmailContent object

Required: Yes

FromEmailAddress

The email address of the customer.

Type: EmailAddressInfo object

Required: Yes

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

Name

The name of a email that is shown to an agent in the Contact Control Panel (CCP).

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Required: No

References

A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Emails can have the following reference types at the time of creation: URL | NUMBER | STRING | DATE. EMAIL | EMAIL_MESSAGE |ATTACHMENT are not a supported reference type during email creation.

Type: String to Reference object map

Key Length Constraints: Minimum length of 1. Maximum length of 4096.

Required: No

RelatedContactId

The contactId that is related to this contact. Linking emails together by using RelatedContactID copies over contact attributes from the related email contact to the new email contact. All updates to user-defined attributes in the new email contact are limited to the individual contact ID. There are no limits to the number of contacts that can be linked by using RelatedContactId.

Type: String

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

Required: No

SegmentAttributes

A set of system defined key-value pairs stored on individual contact segments using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows.

Attribute keys can include only alphanumeric, -, and _.

This field can be used to show channel subtype, such as connect:Guide.

Note

The types application/vnd.amazonaws.connect.message.interactive and application/vnd.amazonaws.connect.message.interactive.response must be present in the SupportedMessagingContentTypes field of this API in order to set SegmentAttributes as {"connect:Subtype": {"valueString" : "connect:Guide" }}.

Type: String to SegmentAttributeValue object map

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Required: No

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 this contact within the Amazon Connect instance.

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