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.

See also: AWS API Documentation

Request Syntax

response = client.put_profile_outbound_request_batch(
    id='string',
    profileOutboundRequests=[
        {
            'clientToken': 'string',
            'profileId': 'string',
            'expirationTime': datetime(2015, 1, 1),
            'eventTriggerContext': {
                'sourceEvent': 'string',
                'channelContext': {
                    'webNotificationContext': {
                        'sessionId': 'string',
                        'browserId': 'string'
                    }
                }
            }
        },
    ]
)
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

      • eventTriggerContext (dict) –

        Event trigger context data

        • sourceEvent (string) –

          Source event object for event triggers

        • channelContext (dict) –

          Additional metadata related to the event trigger context

          • webNotificationContext (dict) –

            Context metadata for the web notification type channel

            • sessionId (string) –

              Session Id for web notification event trigger

            • browserId (string) –

              Browser Id for web notification event trigger

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