AmazonConnectCampaignServiceV2
Provide APIs to create and manage Amazon Connect Campaigns.
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Provide APIs to create and manage Amazon Connect Campaigns.
Endpoints 37
- PUTCreate campaign
/v2/campaignsCreates a campaign for the specified Amazon Connect account. This API is idempotent. - GETDescribe campaign
/v2/campaigns/:idDescribes the specific campaign. - DELETEDelete campaign
/v2/campaigns/:idDeletes a campaign from the specified Amazon Connect account. - POSTUpdate campaign channel subtype config
/v2/campaigns/:id/channel-subtype-configUpdates the channel subtype config of a campaign. This API is idempotent. - DELETEDelete campaign channel subtype config
/v2/campaigns/:id/channel-subtype-config?channelSubtype=stringDeletes the channel subtype config of a campaign. This API is idempotent. - POSTUpdate campaign communication limits
/v2/campaigns/:id/communication-limitsUpdates the communication limits config for a campaign. This API is idempotent. - DELETEDelete campaign communication limits
/v2/campaigns/:id/communication-limits?config=stringDeletes the communication limits config for a campaign. This API is idempotent. - POSTUpdate campaign communication time
/v2/campaigns/:id/communication-timeUpdates the communication time config for a campaign. This API is idempotent. - DELETEDelete campaign communication time
/v2/campaigns/:id/communication-time?config=stringDeletes the communication time config for a campaign. This API is idempotent. - POSTUpdate campaign entry limits
/v2/campaigns/:id/entry-limitsUpdates the entry limits config for a campaign. This API is idempotent. - DELETEDelete campaign entry limits
/v2/campaigns/:id/entry-limitsDeletes the entry limits config for a campaign. This API is idempotent. - GETGet connect instance config
/v2/connect-instance/:connectInstanceId/configGet the specific Connect instance config. - DELETEDelete connect instance config
/v2/connect-instance/:connectInstanceId/config?campaignDeletionPolicy=stringDeletes a connect instance config from the specified AWS account. - POSTDelete connect instance integration
/v2/connect-instance/:connectInstanceId/integrations/deleteDelete the integration for the specified Amazon Connect instance. - GETGet instance onboarding job status
/v2/connect-instance/:connectInstanceId/onboardingGet the specific instance onboarding job status. - PUTStart instance onboarding job
/v2/connect-instance/:connectInstanceId/onboardingOnboard the specific Amazon Connect instance to Connect Campaigns. - DELETEDelete instance onboarding job
/v2/connect-instance/:connectInstanceId/onboardingDelete the Connect Campaigns onboarding job for the specified Amazon Connect instance. - GETGet campaign state
/v2/campaigns/:id/stateGet state of a campaign for the specified Amazon Connect account. - POSTGet campaign state batch
/v2/campaigns-stateGet state of campaigns for the specified Amazon Connect account. - GETGet instance communication limits
/v2/connect-instance/:connectInstanceId/communication-limitsGet the instance communication limits. - PUTPut instance communication limits
/v2/connect-instance/:connectInstanceId/communication-limitsPut the instance communication limits. This API is idempotent. - POSTList campaigns
/v2/campaigns-summaryProvides summary information about the campaigns under the specified Amazon Connect account. - GETList connect instance integrations
/v2/connect-instance/:connectInstanceId/integrations?maxResults=0&nextToken=stringProvides summary information about the integration under the specified Connect instance. - PUTPut connect instance integration
/v2/connect-instance/:connectInstanceId/integrationsPut or update the integration for the specified Amazon Connect instance. - GETList tags for resource
/v2/tags/:arnList tags for a resource. - POSTTag resource
/v2/tags/:arnTag a resource. - DELETEUntag resource
/v2/tags/:arn?tagKeys=Untag a resource. - POSTPause campaign
/v2/campaigns/:id/pausePauses a campaign for the specified Amazon Connect account. - PUTPut outbound request batch
/v2/campaigns/:id/outbound-requestsCreates outbound requests for the specified campaign Amazon Connect account. This API is idempotent. - PUTPut profile outbound request batch
/v2/campaigns/:id/profile-outbound-requestsTakes in a list of profile outbound requests to be placed as part of an outbound campaign. This API is idempotent. - POSTResume campaign
/v2/campaigns/:id/resumeStops a campaign for the specified Amazon Connect account. - POSTStart campaign
/v2/campaigns/:id/startStarts a campaign for the specified Amazon Connect account. - POSTStop campaign
/v2/campaigns/:id/stopStops a campaign for the specified Amazon Connect account. - POSTUpdate campaign flow association
/v2/campaigns/:id/flowUpdates the campaign flow associated with a campaign. This API is idempotent. - POSTUpdate campaign name
/v2/campaigns/:id/nameUpdates the name of a campaign. This API is idempotent. - POSTUpdate campaign schedule
/v2/campaigns/:id/scheduleUpdates the schedule for a campaign. This API is idempotent. - POSTUpdate campaign source
/v2/campaigns/:id/sourceUpdates the campaign source with a campaign. This API is idempotent.
API details
- Base URL
https://connect-campaigns.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 37 operations on 25 pathsPOST 16DELETE 8GET 7PUT 6
- Description format
- AWS Smithy model, API version
2024-04-23 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the AmazonConnectCampaignServiceV2 in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the AmazonConnectCampaignServiceV2 collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Create campaign” (PUT /v2/campaigns), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the AmazonConnectCampaignServiceV2?
Provide APIs to create and manage Amazon Connect Campaigns. It is listed under Developer tools and has 37 endpoints.
Who publishes the AmazonConnectCampaignServiceV2?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the AmazonConnectCampaignServiceV2?
Requests go to https://connect-campaigns.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the AmazonConnectCampaignServiceV2?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the AmazonConnectCampaignServiceV2 have?
37 operations on 25 paths (16 POST, 8 DELETE, 7 GET, 6 PUT).
Is forking the AmazonConnectCampaignServiceV2 free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.