API documentation | API docs for agents | OpenAPI 3.1

import

ark.import_carrier_onboarding_contact

Creates or reuses a dispatcher from a current provider onboarding contact. The operation preserves existing person details and is source-idempotent for the same contact.

Availability: Expanded preview
Scopes: people:writecarriers:read
ARK permissions: canCreatePersoncanViewCarriers
Team visibility: Not entity-scoped
Idempotency-Key: Required for this write
Approval: No MCP approval on REST API-token calls
Rate limit: API credential and organization budgets

Parameters

carrierIdpathstringrequired: format: uuid
contactIdpathstringrequired: Opaque contact ID returned in an onboarding profile dispatcher candidate.; format: uuid
Idempotency-Keyheaderstringrequired: Required for external write operations. Reuse the same key only for exact retries of the same contact import.; min length: 1; max length: 200

Request body

None.

Example request

Shell

curl -X POST 'https://arktms.com/api/v1/carriers/<carrierId>/onboarding-contacts/<contactId>/import' \
  -H "Authorization: Bearer $ARK_API_TOKEN" \
  -H "Idempotency-Key: <unique-key>"

Success response

Onboarding contact import result

objectstringrequired

okbooleanrequired

api_versionstringrequired

request_idstringrequired

dataobjectrequired

data.carrierIdstringrequired

format: uuid

data.contactIdstringrequired

format: uuid

data.providerstringrequired

data.statusstringrequired

one of: created, already_exists, updated_blank_phone, ready_to_create, missing_email, missing_name, invalid_email, skipped

data.reasonstring | nullrequired

data.dispatcherIdstring | nullrequired

format: uuid

data.personIdstring | nullrequired

format: uuid

Errors

HTTP 400: Invalid request
HTTP 401: Authentication required
HTTP 403: Permission, scope, team, or entitlement denied
HTTP 404: Resource not found
HTTP 409: Idempotency conflict or in-progress retry
HTTP 422: Invalid request