ARK TMS

API documentation | API docs for agents | OpenAPI 3.1

POST /api/v1/carriers/provider-onboarding/invite

ark.invite_carrier_provider_onboarding

Sends a carrier onboarding invitation through Highway, RMIS, or MyCarrierPortal using the same provider-specific workflow as the carrier screen.

Availability
Expanded preview
Scopes
carriers:write
ARK permissions
canInviteCarrierExternal
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

Idempotency-Keyheaderstringrequired
Required for external write operations. Reuse the same key only for exact retries of the same request body.
min length: 1; max length: 200

Request body

providerstringrequired

one of: highway, rmis, mycarrierportal

emailstringrequired

format: email; max length: 254

carrierIdstring

format: uuid

dotNumberstring

min length: 1; max length: 32

mcNumberstring

min length: 1; max length: 32

highwayCarrierIdstring

min length: 1; max length: 64

highwayExternalIdstring

min length: 1; max length: 100

companyNamestring

min length: 1; max length: 200

contactNamestring

min length: 1; max length: 200

createUserNamestring

min length: 1; max length: 200

createUserEmailstring

format: email; max length: 254

clientMemberIdstring

min length: 1; max length: 100

Example request

Shell
curl -X POST 'https://arktms.com/api/v1/carriers/provider-onboarding/invite' \
  -H "Authorization: Bearer $ARK_API_TOKEN" \
  -H "Idempotency-Key: <unique-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "provider": "highway",
  "email": "<email>"
}'

Success response

Provider onboarding invitation sent

objectstringrequired
okbooleanrequired
api_versionstringrequired
request_idstringrequired
dataobjectrequired
data.providerstringrequired

one of: highway, rmis, mycarrierportal

data.successbooleanrequired
data.messagestringrequired
data.persistedToCarrierboolean

Errors

HTTP 400
Invalid request
HTTP 401
Authentication required
HTTP 403
Permission, scope, team, or entitlement denied
HTTP 409
Idempotency conflict or in-progress retry
HTTP 422
Invalid request
HTTP 502
External provider or worker queue could not be reached