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

AssociateQueueEmailAddresses

Associates a set of email addresses with a queue to enable agents to select different "From" (system) email addresses when replying to inbound email contacts or initiating outbound email contacts. This allows agents to handle email contacts across different brands and business units within the same queue.

Important things to know

You can associate up to 49 additional email addresses with a single queue, plus 1 default outbound email address, for a total of 50.
The email addresses must already exist in the Amazon Connect instance before they can be associated with a queue.
Agents will be able to select from these associated email addresses when handling email contacts in the queue.
For inbound email contacts, agents can select from email addresses associated with the queue where the contact was accepted.
For outbound email contacts, agents can select from email addresses associated with their default outbound queue configured in their routing profile.

Request Syntax


POST /queues/InstanceId/QueueId/associate-email-addresses HTTP/1.1
Content-type: application/json

{
   "ClientToken": "string",
   "EmailAddressesConfig": [ 
      { 
         "EmailAddressId": "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

QueueId

The identifier for the queue.

Required: Yes

Request Body

The request accepts the following data in JSON format.

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

EmailAddressesConfig

Configuration list containing the email addresses to associate with the queue. Each configuration specifies an email address ID that should be linked to this queue for routing purposes.

Type: Array of EmailAddressConfig objects

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

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

InternalServiceException

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

Message: The message.

HTTP Status Code: 500

InvalidParameterException

One or more of the specified parameters are not valid.

Message: The message about the parameters.

HTTP Status Code: 400

InvalidRequestException

The request is not valid.

Message: The message about the request.
Reason: Reason why the request was invalid.

HTTP Status Code: 400

LimitExceededException

The allowed limit for the resource has been exceeded.

Message: The message about the limit.

HTTP Status Code: 429

ResourceNotFoundException

The specified resource was not found.

Message: The message about the resource.

HTTP Status Code: 404

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429