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

CreateCampaign

Creates an outbound campaign.

Note

For users to be able to view or edit a campaign at a later date by using the Amazon Connect user interface, you must add the instance ID as a tag. For example, { "tags": {"owner": "arn:aws:connect:{REGION}:{AWS_ACCOUNT_ID}:instance/{CONNECT_INSTANCE_ID}"}}.
After a campaign is created, you can't add/remove source.

Request Syntax


PUT /v2/campaigns HTTP/1.1
Content-type: application/json

{
   "channelSubtypeConfig": { 
      "email": { 
         "capacity": number,
         "defaultOutboundConfig": { 
            "connectSourceEmailAddress": "string",
            "sourceEmailAddressDisplayName": "string",
            "wisdomTemplateArn": "string"
         },
         "outboundMode": { ... }
      },
      "sms": { 
         "capacity": number,
         "defaultOutboundConfig": { 
            "connectSourcePhoneNumberArn": "string",
            "wisdomTemplateArn": "string"
         },
         "outboundMode": { ... }
      },
      "telephony": { 
         "capacity": number,
         "connectQueueId": "string",
         "defaultOutboundConfig": { 
            "answerMachineDetectionConfig": { 
               "awaitAnswerMachinePrompt": boolean,
               "enableAnswerMachineDetection": boolean
            },
            "connectContactFlowId": "string",
            "connectSourcePhoneNumber": "string"
         },
         "outboundMode": { ... }
      }
   },
   "communicationLimitsOverride": { 
      "allChannelSubtypes": { ... }
   },
   "communicationTimeConfig": { 
      "email": { 
         "openHours": { ... },
         "restrictedPeriods": { ... }
      },
      "localTimeZoneConfig": { 
         "defaultTimeZone": "string",
         "localTimeZoneDetection": [ "string" ]
      },
      "sms": { 
         "openHours": { ... },
         "restrictedPeriods": { ... }
      },
      "telephony": { 
         "openHours": { ... },
         "restrictedPeriods": { ... }
      }
   },
   "connectCampaignFlowArn": "string",
   "connectInstanceId": "string",
   "name": "string",
   "schedule": { 
      "endTime": "string",
      "refreshFrequency": "string",
      "startTime": "string"
   },
   "source": { ... },
   "tags": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

channelSubtypeConfig

Channel subtype configuration for an outbound campaign.

Type: ChannelSubtypeConfig object

Required: Yes

communicationLimitsOverride

Communication limits configuration for an outbound campaign.

Type: CommunicationLimitsConfig object

Required: No

communicationTimeConfig

Communication time configuration for an outbound campaign.

Type: CommunicationTimeConfig object

Required: No

connectCampaignFlowArn

The Amazon Resource Name (ARN) of the Amazon Connect campaign flow.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 500.

Pattern: arn:[a-zA-Z0-9-]+:[a-zA-Z0-9-]+:[a-z]{2}-[a-z]+-\d{1,2}:[a-zA-Z0-9-]+:[^:]+(?:/[^:]+)*(?:/[^:]+)?(?:\:[^:]+)?

Required: No

connectInstanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Type: String

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

Pattern: [a-zA-Z0-9_\-.]*

Required: Yes

name

The name of the campaign.

Type: String

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

Required: Yes

schedule

Schedule configuration for an outbound campaign.

Type: Schedule object

Required: No

source

Source configuration for an outbound campaign.

Type: Source object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: No

tags

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

Type: String to string map

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

Key Pattern: (?!aws:)[a-zA-Z+-=._:/]+

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

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "arn": "string",
   "id": "string",
   "tags": { 
      "string" : "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.

arn

The Amazon Resource Name (ARN) of the outbound campaign.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 500.

id

The identifier of the outbound campaign.

Type: String

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

Pattern: [a-zA-Z0-9\-:/]*

tags

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

Type: String to string map

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

Key Pattern: (?!aws:)[a-zA-Z+-=._:/]+

Value Length Constraints: Minimum length of 0. 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 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

ResourceNotFoundException

The specified resource does not exist.

HTTP Status Code: 404

ServiceQuotaExceededException

The service quota for your Amazon Connect has been exceeded. Contact AWS Support.

HTTP Status Code: 402

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