API documentation | API docs for agents | OpenAPI 3.1

carrier-invites

ark.create_carrier_invite

Creates a carrier onboarding invite from FMCSA DOT data, sends the invite email, and records the pending invite.

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

emailstringrequired

format: email; max length: 254

dotNumberstringrequired

min length: 1; max length: 20

Example request

Shell

curl -X POST 'https://arktms.com/api/v1/carrier-invites' \
  -H "Authorization: Bearer $ARK_API_TOKEN" \
  -H "Idempotency-Key: <unique-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "email": "<email>",
  "dotNumber": "<dotNumber>"
}'

Success response

Created carrier invite

objectstringrequired

okbooleanrequired

api_versionstringrequired

request_idstringrequired

dataobjectrequired

data.inviteobjectrequired

data.emailSentAtstring | nullrequired

format: date-time

data.messagestringrequired

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 502: External provider or worker queue could not be reached