# Amazon Connect Connect Onboarding API

**Canonical:** https://apis.io/apis/amazon-connect/amazon-connect-onboarding-api/  
**Provider:** Amazon Connect — https://apis.io/providers/amazon-connect/  
**Base URL:** https://connect-campaigns.{region}.amazonaws.com  
**Documentation:** https://docs.aws.amazon.com/connect-outbound/latest/APIReference/Welcome.html

Amazon Connect Connect Onboarding API is one of 98 APIs that [Amazon Connect](https://apis.io/providers/amazon-connect/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. Tagged areas include Connect Onboarding. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

The Connect Onboarding API from Amazon Connect — 2 operation(s) for connect onboarding.

## Operations (6)

| Method | Path | Summary |
|---|---|---|
| DELETE | `/connect-instance/{connectInstanceId}/onboarding` | Delete Instance Onboarding Job |
| GET | `/connect-instance/{connectInstanceId}/onboarding` | Get Instance Onboarding Job Status |
| PUT | `/connect-instance/{connectInstanceId}/onboarding` | Start Instance Onboarding Job |
| DELETE | `/v2/connect-instance/{connectInstanceId}/onboarding` | Delete Instance Onboarding Job |
| GET | `/v2/connect-instance/{connectInstanceId}/onboarding` | Get Instance Onboarding Job Status |
| PUT | `/v2/connect-instance/{connectInstanceId}/onboarding` | Start Instance Onboarding Job |

## Machine-readable artifacts (7)

- **OpenAPI** — https://artifacts.apis.io/amazon-connect/openapi/amazon-connect-onboarding-api-openapi.yml
- **JSONSchema** — https://artifacts.apis.io/amazon-connect/json-schema/amazon-connect-connect-campaigns-start-instance-onboarding-job-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/amazon-connect/json-schema/amazon-connect-start-instance-onboarding-job-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/amazon-connect/json-schema/amazon-connect-get-instance-onboarding-job-status-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/amazon-connect/json-schema/amazon-connect-start-instance-onboarding-job-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/amazon-connect/json-schema/amazon-connect-delete-instance-onboarding-job-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/amazon-connect/json-schema/amazon-connect-get-instance-onboarding-job-status-request-schema.json

## Other Amazon Connect APIs (12)

- [Amazon Connect Streams SDK](https://apis.io/apis/amazon-connect/amazon-connect-streams-sdk/)
- [Amazon AppIntegrations API](https://apis.io/apis/amazon-connect/amazon-appintegrations-api/)
- [Amazon Connect Contact Lens API](https://apis.io/apis/amazon-connect/amazon-connect-contact-lens-api/)
- [Amazon Connect Outbound Campaigns API](https://apis.io/apis/amazon-connect/amazon-connect-outbound-campaigns-api/)
- [Amazon Connect Outbound Campaigns V2 API](https://apis.io/apis/amazon-connect/amazon-connect-outbound-campaigns-v2-api/)
- [Amazon Connect Cases API](https://apis.io/apis/amazon-connect/amazon-connect-cases-api-2/)
- [Amazon Connect Participant Service API](https://apis.io/apis/amazon-connect/amazon-connect-participant-service-api/)
- [Amazon Connect Customer Profiles API](https://apis.io/apis/amazon-connect/amazon-connect-customer-profiles-api/)
- [Amazon Q Connect API](https://apis.io/apis/amazon-connect/amazon-q-connect-api/)
- [Amazon Voice ID API](https://apis.io/apis/amazon-connect/amazon-voice-id-api/)
- [Amazon Connect Agent Statuses API](https://apis.io/apis/amazon-connect/amazon-connect-agent-statuses-api/)
- [Amazon Connect Authentication API](https://apis.io/apis/amazon-connect/amazon-connect-authentication-api/)

## Tags

Connect Onboarding

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/amazon-connect/amazon-connect-onboarding-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/amazon-connect/.