PutProfileOutboundRequestBatch
Takes in a list of profile outbound requests to be placed as part of an outbound campaign. For more information on profiles, see What is a customer profile in Amazon Connect?.
Important
Only Customer Profiles event triggers are permitted to invoke this API.
Request Syntax
PUT /v2/campaigns/id/profile-outbound-requests HTTP/1.1
Content-type: application/json
{
"profileOutboundRequests": [
{
"clientToken": "string",
"expirationTime": "string",
"profileId": "string"
}
]
}URI Request Parameters
The request uses the following URI parameters.
- id
-
The identifier of the outbound campaign.
Length Constraints: Minimum length of 0. Maximum length of 256.
Pattern:
[a-zA-Z0-9\-:/]*Required: Yes
Request Body
The request accepts the following data in JSON format.
- profileOutboundRequests
-
Profile outbound requests for outreaching.
Type: Array of ProfileOutboundRequest objects
Array Members: Minimum number of 1 item. Maximum number of 20 items.
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"failedRequests": [
{
"clientToken": "string",
"failureCode": "string",
"id": "string"
}
],
"successfulRequests": [
{
"clientToken": "string",
"id": "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.
- failedRequests
-
Failed profile outbound requests.
Type: Array of FailedProfileOutboundRequest objects
Array Members: Minimum number of 0 items. Maximum number of 20 items.
- successfulRequests
-
Successful profile outbound requests.
Type: Array of SuccessfulProfileOutboundRequest objects
Array Members: Minimum number of 0 items. Maximum number of 20 items.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
- ConflictException
-
The request could not be processed because of a conflict in the current state of the resource.
HTTP Status Code: 409
- InternalServerException
-
This exception occurs when there is an internal failure in the outbound campaigns.
HTTP Status Code: 500
- InvalidCampaignStateException
-
An attempt was made to modify a campaign that is in a state that is not valid. Check your campaign to ensure that it is in a valid state before retrying the operation.
HTTP Status Code: 409
- ResourceNotFoundException
-
The specified resource does not exist.
HTTP Status Code: 404
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 429
- ValidationException
-
The input fails to satisfy the constraints specified by an AWS service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
