ConnectCampaignServiceV2 / Client / put_profile_outbound_request_batch

put_profile_outbound_request_batch#

ConnectCampaignServiceV2.Client.put_profile_outbound_request_batch(**kwargs)#

Takes in a list of profile outbound requests to be placed as part of an outbound campaign. This API is idempotent.

Request Syntax

response = client.put_profile_outbound_request_batch(
    id='string',
    profileOutboundRequests=[
        {
            'clientToken': 'string',
            'profileId': 'string',
            'expirationTime': datetime(2015, 1, 1)
        },
    ]
)

Parameters:

id (string) –
[REQUIRED]

Identifier representing a Campaign
profileOutboundRequests (list) –
[REQUIRED]

List of profile outbound requests
- (dict) –
  
  Information about a profile outbound request
  - clientToken (string) – [REQUIRED]
    
    Client provided parameter used for idempotency. Its value must be unique for each request.
  - profileId (string) – [REQUIRED]
    
    Identifier of the customer profile
  - expirationTime (datetime) –
    
    Timestamp with no UTC offset or timezone

Return type:

dict

Returns:

Response Syntax

{
    'successfulRequests': [
        {
            'clientToken': 'string',
            'id': 'string'
        },
    ],
    'failedRequests': [
        {
            'clientToken': 'string',
            'id': 'string',
            'failureCode': 'UnknownError'|'ResourceNotFound'|'Conflict'|'RequestThrottled'|'InvalidInput'
        },
    ]
}

Response Structure

(dict) –

The response for PutProfileOutboundRequestBatch API
- successfulRequests (list) –
  
  List of successful profile outbound requests
  - (dict) –
    
    Success details for a profile outbound request
    - clientToken (string) –
      
      Client provided parameter used for idempotency. Its value must be unique for each request.
    - id (string) –
      
      Identifier of the profile outbound request
- failedRequests (list) –
  
  List of failed profile outbound requests
  - (dict) –
    
    Failure details for a profile outbound request
    - clientToken (string) –
      
      Client provided parameter used for idempotency. Its value must be unique for each request.
    - id (string) –
      
      Identifier of the profile outbound request
    - failureCode (string) –
      
      Predefined code indicating the error that caused the failure

Exceptions

ConnectCampaignServiceV2.Client.exceptions.InternalServerException
ConnectCampaignServiceV2.Client.exceptions.ResourceNotFoundException
ConnectCampaignServiceV2.Client.exceptions.ValidationException
ConnectCampaignServiceV2.Client.exceptions.ConflictException
ConnectCampaignServiceV2.Client.exceptions.InvalidCampaignStateException
ConnectCampaignServiceV2.Client.exceptions.AccessDeniedException
ConnectCampaignServiceV2.Client.exceptions.ThrottlingException