Amazon Connect Connect Campaigns API

The Connect Campaigns API from Amazon Connect — 4 operation(s) for connect campaigns.

GitHub OpenAPI

Operations 6

PUT /campaigns Create Campaign #
DELETE /campaigns/{id} Delete Campaign #
GET /campaigns/{id} Describe Campaign #
PUT /v2/campaigns Create Campaign #
DELETE /v2/campaigns/{id} Delete Campaign #
GET /v2/campaigns/{id} Describe Campaign #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-connect:amazon-connect-campaigns-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

amazon-connect-campaigns-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon Connect Service Campaigns API
  version: '2017-08-08'
  description: Generated from AWS's published Smithy model for Amazon Connect Service. 6 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://connect-campaigns.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /campaigns:
    put:
      operationId: CreateCampaign
      summary: Create Campaign
      description: Creates a campaign for the specified Amazon Connect account. This API is idempotent.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateCampaignResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsAccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsServiceQuotaExceededException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCampaignRequest'
      tags:
      - Campaigns
  /campaigns/{id}:
    delete:
      operationId: DeleteCampaign
      summary: Delete Campaign
      description: Deletes a campaign from the specified Amazon Connect account.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsAccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsResourceNotFoundException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteCampaignRequest'
      tags:
      - Campaigns
    get:
      operationId: DescribeCampaign
      summary: Describe Campaign
      description: Describes the specific campaign.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeCampaignResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsAccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsResourceNotFoundException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeCampaignRequest'
      tags:
      - Campaigns
  /v2/campaigns:
    put:
      operationId: CreateCampaign
      summary: Create Campaign
      description: Creates a campaign for the specified Amazon Connect account. This API is idempotent.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateCampaignResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsAccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsServiceQuotaExceededException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConnectCampaignsCreateCampaignRequest'
      tags:
      - Campaigns
      servers:
      - url: https://connect-campaigns.{region}.amazonaws.com
        variables:
          region:
            default: us-east-1
  /v2/campaigns/{id}:
    delete:
      operationId: DeleteCampaign
      summary: Delete Campaign
      description: Deletes a campaign from the specified Amazon Connect account.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsAccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsResourceNotFoundException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteCampaignRequest'
      tags:
      - Campaigns
      servers:
      - url: https://connect-campaigns.{region}.amazonaws.com
        variables:
          region:
            default: us-east-1
    get:
      operationId: DescribeCampaign
      summary: Describe Campaign
      description: Describes the specific campaign.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsDescribeCampaignResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsAccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsResourceNotFoundException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeCampaignRequest'
      tags:
      - Campaigns
      servers:
      - url: https://connect-campaigns.{region}.amazonaws.com
        variables:
          region:
            default: us-east-1
components:
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
        request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: connect-campaigns
  schemas:
    AbandonmentRatePacingConfig:
      type: object
      properties:
        targetRate:
          type: number
        connectionStartPoint:
          type: string
          description: Event from which connectionThresholdSeconds is measured.
        connectionThresholdSeconds:
          type: integer
          description: Seconds after connectionStartPoint before a contact counts as abandoned.
        evaluationWindow:
          type: string
          description: Rolling window over which abandonmentRate is computed.
      required:
      - targetRate
      - connectionStartPoint
      - connectionThresholdSeconds
      - evaluationWindow
    AgentlessConfig:
      type: object
      properties: {}
    AgentlessDialerConfig:
      type: object
      properties:
        dialingCapacity:
          type: number
    ChannelSubtypeConfig:
      type: object
      properties:
        telephony:
          $ref: '#/components/schemas/TelephonyChannelSubtypeConfig'
        sms:
          $ref: '#/components/schemas/SmsChannelSubtypeConfig'
        email:
          $ref: '#/components/schemas/EmailChannelSubtypeConfig'
        whatsApp:
          $ref: '#/components/schemas/WhatsAppChannelSubtypeConfig'
    CommunicationLimit:
      type: object
      properties:
        maxCountPerRecipient:
          type: integer
          description: Maximum number of contacts allowed for a given target within the given frequency.
        frequency:
          type: integer
          description: The number of days to consider with regards to this limit.
        unit:
          type: string
      required:
      - maxCountPerRecipient
      - frequency
      - unit
    CommunicationLimits:
      type: object
      properties:
        communicationLimitsList:
          type: array
          items:
            $ref: '#/components/schemas/CommunicationLimit'
      description: Exactly one member is set.
    CommunicationLimitsConfig:
      type: object
      properties:
        allChannelSubtypes:
          $ref: '#/components/schemas/CommunicationLimits'
        instanceLimitsHandling:
          type: string
    CommunicationTimeConfig:
      type: object
      properties:
        localTimeZoneConfig:
          $ref: '#/components/schemas/LocalTimeZoneConfig'
        telephony:
          $ref: '#/components/schemas/TimeWindow'
        sms:
          $ref: '#/components/schemas/TimeWindow'
        email:
          $ref: '#/components/schemas/TimeWindow'
        whatsApp:
          $ref: '#/components/schemas/TimeWindow'
      required:
      - localTimeZoneConfig
    ConnectCampaignsAccessDeniedException:
      type: object
      properties:
        message:
          type: string
        xAmzErrorType:
          type: string
      required:
      - message
    ConnectCampaignsAnswerMachineDetectionConfig:
      type: object
      properties:
        enableAnswerMachineDetection:
          type: boolean
          description: Enable or disable answering machine detection
        awaitAnswerMachinePrompt:
          type: boolean
          description: Enable or disable await answer machine prompt
      required:
      - enableAnswerMachineDetection
    ConnectCampaignsCampaign:
      type: object
      properties:
        id:
          type: string
        arn:
          type: string
        name:
          type: string
        connectInstanceId:
          type: string
        dialerConfig:
          $ref: '#/components/schemas/DialerConfig'
        outboundCallConfig:
          $ref: '#/components/schemas/OutboundCallConfig'
        tags:
          type: object
          additionalProperties:
            type: string
      required:
      - id
      - arn
      - name
      - connectInstanceId
      - dialerConfig
      - outboundCallConfig
    ConnectCampaignsConflictException:
      type: object
      properties:
        message:
          type: string
        xAmzErrorType:
          type: string
      required:
      - message
    ConnectCampaignsCreateCampaignRequest:
      type: object
      properties:
        name:
          type: string
        connectInstanceId:
          type: string
        channelSubtypeConfig:
          $ref: '#/components/schemas/ChannelSubtypeConfig'
        type:
          type: string
        source:
          $ref: '#/components/schemas/Source'
        connectCampaignFlowArn:
          type: string
        schedule:
          $ref: '#/components/schemas/Schedule'
        entryLimitsConfig:
          $ref: '#/components/schemas/EntryLimitsConfig'
        communicationTimeConfig:
          $ref: '#/components/schemas/CommunicationTimeConfig'
        communicationLimitsOverride:
          $ref: '#/components/schemas/CommunicationLimitsConfig'
        tags:
          type: object
          additionalProperties:
            type: string
      required:
      - name
      - connectInstanceId
    ConnectCampaignsDescribeCampaignResponse:
      type: object
      properties:
        campaign:
          $ref: '#/components/schemas/ConnectCampaignsCampaign'
    ConnectCampaignsInternalServerException:
      type: object
      properties:
        message:
          type: string
        xAmzErrorType:
          type: string
      required:
      - message
    ConnectCampaignsResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
        xAmzErrorType:
          type: string
      required:
      - message
    ConnectCampaignsServiceQuotaExceededException:
      type: object
      properties:
        message:
          type: string
        xAmzErrorType:
          type: string
      required:
      - message
    ConnectCampaignsThrottlingException:
      type: object
      properties:
        message:
          type: string
        xAmzErrorType:
          type: string
      required:
      - message
    ConnectCampaignsValidationException:
      type: object
      properties:
        message:
          type: string
        xAmzErrorType:
          type: string
      required:
      - message
    CreateCampaignRequest:
      type: object
      properties:
        name:
          type: string
        connectInstanceId:
          type: string
        dialerConfig:
          $ref: '#/components/schemas/DialerConfig'
        outboundCallConfig:
          $ref: '#/components/schemas/OutboundCallConfig'
        tags:
          type: object
          additionalProperties:
            type: string
      required:
      - name
      - connectInstanceId
      - dialerConfig
      - outboundCallConfig
    CreateCampaignResponse:
      type: object
      properties:
        id:
          type: string
        arn:
          type: string
        tags:
          type: object
          additionalProperties:
            type: string
    DeleteCampaignRequest:
      type: object
      properties:
        id:
          type: string
      required:
      - id
    DescribeCampaignRequest:
      type: object
      properties:
        id:
          type: string
      required:
      - id
    DescribeCampaignResponse:
      type: object
      properties:
        campaign:
          $ref: '#/components/schemas/ConnectCampaignsCampaign'
    DialerConfig:
      type: object
      properties:
        progressiveDialerConfig:
          $ref: '#/components/schemas/ProgressiveDialerConfig'
        predictiveDialerConfig:
          $ref: '#/components/schemas/PredictiveDialerConfig'
        agentlessDialerConfig:
          $ref: '#/components/schemas/AgentlessDialerConfig'
      description: Exactly one member is set.
    EmailChannelSubtypeConfig:
      type: object
      properties:
        capacity:
          type: number
        outboundMode:
          $ref: '#/components/schemas/EmailOutboundMode'
        defaultOutboundConfig:
          $ref: '#/components/schemas/EmailOutboundConfig'
      required:
      - outboundMode
      - defaultOutboundConfig
    EmailOutboundConfig:
      type: object
      properties:
        connectSourceEmailAddress:
          type: string
        sourceEmailAddressDisplayName:
          type: string
        wisdomTemplateArn:
          type: string
      required:
      - connectSourceEmailAddress
      - wisdomTemplateArn
    EmailOutboundMode:
      type: object
      properties:
        agentless:
          $ref: '#/components/schemas/AgentlessConfig'
      description: Exactly one member is set.
    EntryLimitsConfig:
      type: object
      properties:
        maxEntryCount:
          type: integer
          description: Maximum number of times a participant can enter the campaign. A value of 0 indicates unlimited entries.
            Values of 1 or greater specify the exact number of entries allowed.
        minEntryInterval:
          type: string
          description: Minimum time interval that must pass before a participant can enter the campaign again.
      required:
      - maxEntryCount
      - minEntryInterval
    EventTrigger:
      type: object
      properties:
        customerProfilesDomainArn:
          type: string
    LocalTimeZoneConfig:
      type: object
      properties:
        defaultTimeZone:
          type: string
        localTimeZoneDetection:
          type: array
          items:
            type: string
        localTimeZoneDetectionScope:
          type: string
    OpenHours:
      type: object
      properties:
        dailyHours:
          type: object
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/TimeRange'
      description: Exactly one member is set.
    OutboundCallConfig:
      type: object
      properties:
        connectContactFlowId:
          type: string
        connectSourcePhoneNumber:
          type: string
        connectQueueId:
          type: string
        answerMachineDetectionConfig:
          $ref: '#/components/schemas/ConnectCampaignsAnswerMachineDetectionConfig'
      required:
      - connectContactFlowId
    PacingStrategy:
      type: object
      properties:
        abandonmentRate:
          $ref: '#/components/schemas/AbandonmentRatePacingConfig'
      description: Exactly one member is set.
    PredictiveConfig:
      type: object
      properties:
        bandwidthAllocation:
          type: number
        pacingStrategies:
          type: array
          items:
            $ref: '#/components/schemas/PacingStrategy'
          description: Pacing strategies the dialer enforces simultaneously.
      required:
      - bandwidthAllocation
    PredictiveDialerConfig:
      type: object
      properties:
        bandwidthAllocation:
          type: number
        dialingCapacity:
          type: number
      required:
      - bandwidthAllocation
    PreviewConfig:
      type: object
      properties:
        bandwidthAllocation:
          type: number
        timeoutConfig:
          $ref: '#/components/schemas/TimeoutConfig'
        agentActions:
          type: array
          items:
            type: string
      required:
      - bandwidthAllocation
      - timeoutConfig
    ProgressiveConfig:
      type: object
      properties:
        bandwidthAllocation:
          type: number
      required:
      - bandwidthAllocation
    ProgressiveDialerConfig:
      type: object
      properties:
        bandwidthAllocation:
          type: number
        dialingCapacity:
          type: number
      required:
      - bandwidthAllocation
    RestrictedPeriod:
      type: object
      properties:
        name:
          type: string
        startDate:
          type: string
        endDate:
          type: string
      required:
      - startDate
      - endDate
    RestrictedPeriods:
      type: object
      properties:
        restrictedPeriodList:
          type: array
          items:
            $ref: '#/components/schemas/RestrictedPeriod'
      description: Exactly one member is set.
    Schedule:
      type: object
      properties:
        startTime:
          type: string
          format: date-time
        endTime:
          type: string
          format: date-time
        refreshFrequency:
          type: string
      required:
      - startTime
      - endTime
    SmsChannelSubtypeConfig:
      type: object
      properties:
        capacity:
          type: number
        outboundMode:
          $ref: '#/components/schemas/SmsOutboundMode'
        defaultOutboundConfig:
          $ref: '#/components/schemas/SmsOutboundConfig'
      required:
      - outboundMode
      - defaultOutboundConfig
    SmsOutboundConfig:
      type: object
      properties:
        connectSourcePhoneNumberArn:
          type: string
        wisdomTemplateArn:
          type: string
      required:
      - connectSourcePhoneNumberArn
      - wisdomTemplateArn
    SmsOutboundMode:
      type: object
      properties:
        agentless:
          $ref: '#/components/schemas/AgentlessConfig'
      description: Exactly one member is set.
    Source:
      type: object
      properties:
        customerProfilesSegmentArn:
          type: string
        eventTrigger:
          $ref: '#/components/schemas/EventTrigger'
      description: Exactly one member is set.
    TelephonyChannelSubtypeConfig:
      type: object
      properties:
        capacity:
          type: number
        connectQueueId:
          type: string
        outboundMode:
          $ref: '#/components/schemas/TelephonyOutboundMode'
        defaultOutboundConfig:
          $ref: '#/components/schemas/TelephonyOutboundConfig'
      required:
      - outboundMode
      - defaultOutboundConfig
    TelephonyOutboundConfig:
      type: object
      properties:
        connectContactFlowId:
          type: string
        connectSourcePhoneNumber:
          type: string
        answerMachineDetectionConfig:
          $ref: '#/components/schemas/ConnectCampaignsAnswerMachineDetectionConfig'
        ringTimeout:
          type: integer
      required:
      - connectContactFlowId
    TelephonyOutboundMode:
      type: object
      properties:
        progressive:
          $ref: '#/components/schemas/ProgressiveConfig'
        predictive:
          $ref: '#/components/schemas/PredictiveConfig'
        agentless:
          $ref: '#/components/schemas/AgentlessConfig'
        preview:
          $ref: '#/components/schemas/PreviewConfig'
      description: Exactly one member is set.
    TimeRange:
      type: object
      properties:
        startTime:
          type: string
        endTime:
          type: string
      required:
      - startTime
      - endTime
    TimeWindow:
      type: object
      properties:
        openHours:
          $ref: '#/components/schemas/OpenHours'
        restrictedPeriods:
          $ref: '#/components/schemas/RestrictedPeriods'
      required:
      - openHours
    TimeoutConfig:
      type: object
      properties:
        durationInSeconds:
          type: integer
      required:
      - durationInSeconds
    WhatsAppChannelSubtypeConfig:
      type: object
      properties:
        capacity:
          type: number
        outboundMode:
          $ref: '#/components/schemas/WhatsAppOutboundMode'
        defaultOutboundConfig:
          $ref: '#/components/schemas/WhatsAppOutboundConfig'
      required:
      - outboundMode
      - defaultOutboundConfig
    WhatsAppOutboundConfig:
      type: object
      properties:
        connectSourcePhoneNumberArn:
          type: string
        wisdomTemplateArn:
          type: string
      required:
      - connectSourcePhoneNumberArn
      - wisdomTemplateArn
    WhatsAppOutboundMode:
      type: object
      properties:
        agentless:
          $ref: '#/components/schemas/AgentlessConfig'
      description: Exactly one member is set.
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/connectcampaigns/service/2021-01-30/connectcampaigns-2021-01-30.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)
  sources:
  - https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/connectcampaigns/service/2021-01-30/connectcampaigns-2021-01-30.json
  - https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/connectcampaignsv2/service/2024-04-23/connectcampaignsv2-2024-04-23.json